Skip to content

CLAUDE.md

Latest commit

 

History

History
37 lines (31 loc) · 2.41 KB

CLAUDE.md

File metadata and controls

37 lines (31 loc) · 2.41 KB
Raw

Commits and code style

  • 2 space indents
  • One logical change per commit
  • Commit subjects: one line, under 50 characters (GitHub's display limit), sentence case
  • A commit subject says what the change does, NEVER "Release x.y.z". "Spell out the headline duration", not "Release 1.8.2" or "Bump version". This holds when the same commit adds the changelog entry that publishes a release: the version lives in CHANGELOG.md and the tag, the commit log is for the work. Rolle on 15.10.2026, after 37 such commits in train-netmap: "I hate that. Even though we do release shit, commit should always depict on what has been done"
  • Commit each change
  • Use present tense in commits and CHANGELOG.md
  • Use sentence case for headings (not Title Case)
  • Never use bold text as headings, use proper heading levels instead
  • Always add an empty line after headings
  • No formatting in CHANGELOG.md except inline code and when absolute necessary
  • Use * as bullets in CHANGELOG.md
  • CHANGELOG.md bullets: 2-10 words
  • Rationale belongs in code comments or docs, never in commits or CHANGELOG.md
  • Real semver: patch = fix/tweak, minor = new capability, major = breaking change. Default to patch
  • Patch unless the release adds a thing that did not exist: a new script, tool, integration or config file. Editing, tuning, fixing or removing existing config is a patch, however many files it touches
  • One version bump per work session, not per commit or per fix. Consolidate same-day changes into it
  • Never use Claude watermark in commits (FORBIDDEN: "Co-Authored-By")
  • No emojis in commits or code
  • Keep CHANGELOG.md date up to date when adding entries
  • Never use "====" separators or underlines with "=", if you must use them, prefer dash or single line separators or headings that match the text width

Versioning

Files that contain version numbers and must be updated on each release:

  • README.md - badge in line 3 (version-X.Y.Z)
  • CHANGELOG.md - new entry at the top

Claude Code workflow

  • Always add tasks to the Claude Code to-do list and keep it up to date.
  • Review your to-do list and prioritize before starting.
  • If new tasks come in, don't jump to them right away—add them to the list in order of urgency and finish your current work first.
  • Do not ever guess features, always proof them via looking up official docs, GitHub code, issues, if possible.
  • When looking things up, do not use years in search terms like 2024 or 2025.