Skip to content

Update CLAUDE.md with coding guidelines #11

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
lloydwatkin merged 1 commit into from
Sep 19, 2026
Merged

Update CLAUDE.md with coding guidelines #11

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions CLAUDE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -79,3 +79,10 @@ State the behaviour and its condition, not the mechanics:
Prefer a long description to a comment explaining a short one. Favour the
language of the README and the MCP tools — resources, attributes, permitted
params, authorization — over the language of the implementation.

# Guidelines

* ALWAYS use descriptive method and variable names instead of comments. Don't add comments to code — names should carry the meaning
* ALWAYS use British English everywhere — strings, comments, identifiers, method/variable names, commit messages. (favourite, colour, organisation.)
* ALWAYS use inclusive language. Avoid gendered pronouns and acronyms
* NEVER run the full test suite locally. Push the branch and let the GitHub Actions run cover it. Locally, run only the specs for the files you touched plus what they cascade into.
Loading