Normalize markdown formatting in documentation

- Use consistent dash-style bullet points
- Remove trailing whitespace
- Add missing blank lines between sections
- Add trailing newline to README.md
This commit is contained in:
2025-12-18 01:29:56 -08:00
parent dae6c64e24
commit 61c17ca585
2 changed files with 33 additions and 23 deletions

View File

@@ -1,20 +1,20 @@
# Important Rules
* when fixing a bug, write a failing test FIRST. only after the test fails, write
the code to fix the bug. then ensure the test passes. leave the test in
place and commit it with the bugfix. don't run shell commands to test
bugfixes or reproduce bugs. write tests!
- when fixing a bug, write a failing test FIRST. only after the test fails, write
the code to fix the bug. then ensure the test passes. leave the test in
place and commit it with the bugfix. don't run shell commands to test
bugfixes or reproduce bugs. write tests!
* never, ever mention claude or anthropic in commit messages. do not use attribution
- never, ever mention claude or anthropic in commit messages. do not use attribution
* after each change, run "make fmt".
- after each change, run "make fmt".
* after each change, run "make test" and ensure all tests pass.
- after each change, run "make test" and ensure all tests pass.
* after each change, run "make lint" and ensure no linting errors. fix any
- after each change, run "make lint" and ensure no linting errors. fix any
you find, one by one.
* after each change, commit the files you've changed. push after
- after each change, commit the files you've changed. push after
committing.
* NEVER use `git add -A`. always add only individual files that you've changed.
- NEVER use `git add -A`. always add only individual files that you've changed.