Defame1297
e09d1cd297
## Why
`core/AGENTS.md` referenced a non-existent path (`~/.claude/core/commits.md`)
instead of the correct `~/.claude/core/instructions/commits.md`, and contained a
typo ("commiting" → "committing"). `core/instructions/commits.md` was wrapped in
an erroneous markdown code fence that caused agents reading the file to see it as
a raw text block rather than a live template with usable HTML comment sections.
## Impact
Agents following the content index in AGENTS.md will now resolve the correct path
for commit conventions. The commits template is now properly structured so its
comment-gated sections render as intended.
Co-authored-by: Claude Sonnet 4.6 <noreply@anthropic.com>
79 lines
1.8 KiB
Markdown
79 lines
1.8 KiB
Markdown
<!--
|
|
<type>(<scope>): <concise summary>
|
|
Required.
|
|
|
|
Purpose:
|
|
- Quickly communicates the intent when scanning `git log`.
|
|
- Follow Conventional Commits for consistency and tooling.
|
|
- Describe the intended outcome, not the implementation.
|
|
|
|
Examples:
|
|
feat(auth): support OAuth device flow
|
|
fix(cache): prevent stale session reuse
|
|
refactor(api): simplify request validation
|
|
-->
|
|
|
|
## Why
|
|
<!--
|
|
Explain why this change exists.
|
|
|
|
This is the most valuable part of the commit because the code diff
|
|
already shows WHAT changed. Future maintainers (human or AI) often
|
|
need to understand WHY the change was made.
|
|
|
|
Include, where applicable:
|
|
- Problem being solved
|
|
- User or business need
|
|
- Bug or root cause
|
|
- Important context that is not visible in the code
|
|
|
|
Omit if the reason is immediately obvious.
|
|
-->
|
|
|
|
## Implementation Notes
|
|
<!--
|
|
Capture decisions that are difficult to infer from the code.
|
|
|
|
Useful information includes:
|
|
- Why this approach was chosen
|
|
- Important assumptions or invariants
|
|
- Constraints imposed by external systems
|
|
- Tradeoffs or intentional compromises
|
|
- Non-obvious implementation details
|
|
- Workarounds or temporary solutions
|
|
|
|
Do NOT describe the diff ("renamed X", "added Y", etc.).
|
|
The code already documents that.
|
|
Omit if there is nothing worth preserving.
|
|
-->
|
|
|
|
## Impact
|
|
<!--
|
|
Document effects that future developers should know.
|
|
|
|
Examples:
|
|
- Behavior changes
|
|
- Breaking changes
|
|
- Performance implications
|
|
- Security considerations
|
|
- Migration or deployment requirements
|
|
- Compatibility concerns
|
|
- Follow-up work or known limitations
|
|
|
|
Omit if there are no noteworthy impacts.
|
|
-->
|
|
|
|
---
|
|
# References
|
|
<!-- Git Trailers: Structured metadata for traceability and tooling. Use only the trailers that apply. -->
|
|
|
|
Fixes:
|
|
Refs:
|
|
ADR:
|
|
RFC:
|
|
Design:
|
|
Co-authored-by:
|
|
Reviewed-by:
|
|
Signed-off-by:
|
|
BREAKING CHANGE:
|