mirror of
https://github.com/priyanshujain/sanderling.git
synced 2026-10-02 19:17:10 +00:00
pj
e62319e916
* chore(prose): remove em-dashes from config files * chore(prose): remove em-dashes from android sdk config * docs(spec-api): remove em-dash from README * fix(doctor): reword sidecar-jar error without em-dash * test(sidecar): reword assertion message without em-dash * docs: add CLAUDE.md with project conventions * build: add docs target for pandoc site * docs(site): add pandoc template and stylesheet * docs(site): add pandoc build script * docs(site): add landing pages * docs(manual): add getting-started * docs(manual): add writing-specs * docs(manual): add runs * docs(manual): add cli reference * docs(dev): add design principles * docs(dev): add architecture * ci: deploy docs site to github pages * docs: rewrite README as entry point to docs site
26 lines
1.3 KiB
Markdown
26 lines
1.3 KiB
Markdown
## Project Guidelines
|
|
|
|
- Do not call the task done until it is fully complete and tested.
|
|
- Always write tests for new features and bug fixes.
|
|
- Do not dismiss bug as a pre-existing" issue even if it was present before your change. It does not matter, it's still your responsibility to fix it. When you see a bug, fix it. Don't ignore it.
|
|
- Always build a feature in a new branch. Do not push directly to the main branch. Always check current branch before pushing.
|
|
|
|
## Coding Guidelines
|
|
|
|
- Keep code simple and easy to read.
|
|
- Avoid excessive comments. Only comment when absolutely necessary.
|
|
- Create WIP pull requests when you start working on a feature, and update the PR as you make progress
|
|
|
|
## Git Branch Rules
|
|
|
|
- No slashes in branch names (e.g., use `fix-something` not `fix/something`).
|
|
|
|
## Git Commit Rules
|
|
|
|
- Commit after every small, atomic change. Each commit should touch 1-3 files max.
|
|
- Use conventional commit format: `feat|fix|refactor|docs|test|chore|ci(scope): message`
|
|
- Never use `git add .` or `git add -A`. Always stage specific files by name.
|
|
- Keep commits small: aim for under 20 lines changed per commit.
|
|
- Don't batch multiple unrelated changes into one commit.
|
|
- Commit early and often. A working 5-line change is better than a pending 200-line change.
|