title	Contributing Guide
description	Contribution workflow, validation commands, and documentation/changelog expectations for Note Sync Now.
permalink	/contributing/

Contributing to Note Sync Now / Brave Sync Notes

Thank you for your interest in contributing.

Navigation

Fork the repository and create a feature branch:
- git checkout -b feature/your-feature-name
Make your changes in small, focused commits.
Run the relevant validation locally:
- cd brave-sync-notes/client && npm ci && npm test -- --run && npm run build
- cd brave-sync-notes/server && npm ci && npm test
- cd brave-sync-notes/server && npm run test:property (recommended when touching sync, persistence, or validation logic)
Add or update a record in changelog/ for every submitted change set.
Open a pull request with a clear description of the change and related issue(s).

Keep root documentation aligned with the GitHub Pages site.
Prefer updating the relevant overview / architecture / deployment / security page instead of duplicating explanations across files.
When changing workflows or project structure, update both the docs page and the changelog entry in the same change set.

Keep functions small and focused.
Prefer clear naming over short names.
Reuse existing test frameworks and project structure before introducing new tooling.

Use descriptive commit messages.
Optionally follow the conventional commits style (e.g. feat:, fix:, docs:).

Do not commit secrets (API keys, passwords, tokens).
If you discover a security issue, please report it privately instead of creating a public issue first.