Cursor rule

1---
2description: When preparing a git commit or a PR always check these steps
3globs: 
4alwaysApply: false
5---
6When making a commit run git status to see what the local changes are.
7 
8Don't worry about untracked files that you don't recognize. We often have a lot of local cruft that doesn't need to be tracked.
9 
10Make sure to add any new currently untracked files that you've introduced and if there are important looking files that might need to be tracked ask me about it.
11 
12Once you've got all the correct files being tracked check the diff between the current branch and `main` (ignoring untracked files) to fully understand what changes are in progress.
13 
14Check that ARCHITECTURE.md and ONBOARDING.md are up-to-date with the changes in progress. If they're not up-to-date then update those files, keeping consistency with the existing approach in those files, update them so that they are up to date with the changes in progress and the current state of the code in general. Make sure to read in the actual files at this stage to make sure that you get this right. Note in many cases for smaller or implementation detail changes you won't need to change these files, don't modify them unnecessarily.
15 
16Ensure that any new or changed functionality has test coverage including test coverage for failure and 'unhappy path' cases. If test coverage is missing and not trivial to add, write a report of the missing tests to a markdown file and then check with me.
17 
18Make sure that build and test are passing.
19 
20Remove any debug logging that's been left in the changes in progress. We often commit this accidentally so it's good to clean up, but only do this once tests are passing!
21