Skip to content

feat: add planning and code-comment preferences, tighten breaking-change rule - #1

Merged
gsdevme merged 2 commits into
mainfrom
feat/preference-updates
Aug 30, 2026
Merged

gsdevme merged 2 commits into
mainfrom
feat/preference-updates

Conversation

@gsdevme

@gsdevme gsdevme commented Jul 9, 2026

Copy link
Copy Markdown
Owner

Summary

Three preference updates:

  • planning.md (new): plans written to local paths (~/.claude/, /tmp, …) are session-only context and must never be referenced from PRs, commits, or code comments; load-bearing plans go in the repo under docs/plans/ where they can be linked durably.
  • code-comments.md (new): favour file/class/function/method documentation blocks over inline comments, keep code bodies lean (no narration, no change-history notes, no commented-out code), with YAML and other comment-only config formats exempt.
  • commits.md: breaking changes are now marked with a BREAKING CHANGE: footer only — the ! type/scope marker is no longer allowed. The !-style example was replaced with a footer-style one.

Each change is wired into ~/.claude/CLAUDE.md via the repo's documented @-import mechanism (the import lines live outside this repo, per the README).

Test plan

  • Confirmed ~/.claude/CLAUDE.md imports each topic file by absolute path and the files load in a new session.

🤖 Generated with Claude Code

@gsdevme
gsdevme force-pushed the feat/preference-updates branch from 0d86260 to 86754af Compare August 30, 2026 20:08
@gsdevme
gsdevme merged commit c2fb48c into main Aug 30, 2026
4 checks passed
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