sneak/pixa
1
0
Fork 0
Code Issues 2 Pull Requests Actions Packages Projects Releases Wiki Activity

Add TDD and commit workflow rules to CLAUDE.md

Browse Source
This commit is contained in:
Jeffrey Paul
2026-01-08 03:36:22 -08:00
parent b14c897408
commit d9e57de108
1 changed files with 22 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

22
CLAUDE.md
View File

@@ -14,3 +14,25 @@
output by the linter is something that legitimately needs fixing in the output by the linter is something that legitimately needs fixing in the
code. code.
* when running tests, use `make test`.
* before commits, run `make check`. this runs `make lint` and `make test`
and `make check-fmt`. any issues discovered must be resolved before
committing unless explicitly told otherwise.
* when fixing a bug, write a failing test for the bug FIRST. add
appropriate logging to the test to ensure it is written correctly. commit
that. then go about fixing the bug until the test passes (without
modifying the test further). then commit that.
* when adding a new feature, do the same - implement a test first (TDD). it
doesn't have to be super complex. commit the test, then commit the
feature.
* when adding a new feature, use a feature branch. when the feature is
completely finished and the code is up to standards (passes `make check`)
then and only then can the feature branch be merged in to `main` and the
branch deleted.
* write godoc documentation comments for all exported types and functions as
you go along.