Skip to content

docs: add CODING_STANDARDS.md and GLOSSARY.md - #4

Merged
catesandrew merged 1 commit into
mainfrom
docs/coding-standards-glossary
Nov 6, 2026
Merged

catesandrew merged 1 commit into
mainfrom
docs/coding-standards-glossary

Conversation

@catesandrew

Copy link
Copy Markdown
Collaborator

What

Adds two root docs, both generated from this repo's real code and config:

  • CODING_STANDARDS.md: conventions the code actually follows (formatting, naming, errors, tests, commits), a table of counted inconsistencies, and anything aspirational marked as such. Source files are not changed.
  • GLOSSARY.md: project vocabulary in the mattpocock-skills glossary format (Language, Relationships, Flagged ambiguities).

Review notes

  • Docs only. No source, config or CI changes.
  • Flagged ambiguities entries are observations from the repo, with suggested wording where the repo does not record a decision. Please correct any term that is wrong.
  • Counts in the inconsistency table come from sampling and regex scans, so treat them as approximate.

🤖 Generated with Claude Code

CODING_STANDARDS.md records the conventions the code actually follows, with counted inconsistencies, generated with the write-coding-standards-from-file skill from the repo source and config. GLOSSARY.md records the project vocabulary in the mattpocock-skills glossary format.

Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
@catesandrew
catesandrew merged commit 9641350 into main Nov 6, 2026
1 check passed
@catesandrew
catesandrew deleted the docs/coding-standards-glossary branch November 6, 2026 21:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant