From 7e7df12aa7bb3584ec4df57365c0363a1aeb2924 Mon Sep 17 00:00:00 2001 From: PJ Date: Sat, 20 Jun 2026 14:47:30 -0400 Subject: [PATCH] chore: add project guidelines --- CLAUDE.md | 24 ++++++++++++++++++++++++ 1 file changed, 24 insertions(+) create mode 100644 CLAUDE.md diff --git a/CLAUDE.md b/CLAUDE.md new file mode 100644 index 0000000..80d1508 --- /dev/null +++ b/CLAUDE.md @@ -0,0 +1,24 @@ +## Project Guidelines + +- Do not call the task done until it is fully complete and tested. +- 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. Code should be readable and not require comments to understand it. + - 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.