From f76cf01e843ac83b654fd50ef68aee255f998dc3 Mon Sep 17 00:00:00 2001 From: Lloyd Watkin Date: Sat, 19 Sep 2026 09:19:51 +0100 Subject: [PATCH] Update CLAUDE.md with coding guidelines Added guidelines for naming conventions, language usage, and testing practices. --- CLAUDE.md | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/CLAUDE.md b/CLAUDE.md index 41b8b34..b4f1a57 100644 --- a/CLAUDE.md +++ b/CLAUDE.md @@ -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.