Skip to content

Commit 7635487

Browse files
committed
[changelog] Clarify changelog update rules and enhance documentation on change impact
Signed-off-by: Felipe Sayão Lobato Abreu <github@mentordosnerds.com>
1 parent 720bce3 commit 7635487

1 file changed

Lines changed: 13 additions & 6 deletions

File tree

  • .agents/skills/github-pull-request

.agents/skills/github-pull-request/SKILL.md

Lines changed: 13 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -21,18 +21,25 @@ Use this skill to take a Fast Forward issue from "ready to implement" to an open
2121
- Branch from `main` or the repository integration branch, never from another feature branch.
2222
- Prefer local `git` for checkout, commit, and push.
2323
- Prefer connector-backed GitHub data for issue and PR context when available.
24-
- Use `phpunit-tests`, `package-readme`, `sphinx-docs`, and `changelog-generator` when the change clearly affects tests or documentation.
24+
- Use `phpunit-tests`, `package-readme`, `sphinx-docs`, and `changelog-generator` whenever a change affects testable behavior, public APIs, documented usage, or the change history — including adding, modifying, or removing features, bug fixes, or contract changes.
2525
- Never manually close an issue; rely on `Closes #123` style text in the PR body.
2626
- Do not block waiting for merge. Open or update the PR, then report status and the next action.
2727

2828
## Changelog Updates
2929

30-
When implementing changes that affect functionality, use `changelog-generator` to update CHANGELOG.md:
30+
For any change that is user-visible or affects behavior, use `changelog-generator` to update CHANGELOG.md.
3131

32-
1. Run `changelog-generator` to analyze code changes since last release
33-
2. Add clear, specific descriptions following the skill's quality rules
34-
3. Include PR reference when applicable: "Added changelog automation (#40)"
35-
4. Update the [Unreleased] section for PR-specific changes
32+
1. Use the `changelog-generator` skill to analyze code changes since last release
33+
2. Add entries under the [Unreleased] section only for PR-specific changes
34+
3. Write concise, specific, user-facing descriptions (avoid implementation details) following the skill's quality rules
35+
4. Include PR reference when applicable: "Added changelog automation (#40)"
36+
5. Group entries by type if applicable (e.g., Added, Fixed, Changed, Breaking)
37+
38+
**Rules**:
39+
40+
- Do not duplicate existing entries
41+
- Do not move or modify past releases
42+
- Every eligible PR must include its changelog entry before merge
3643

3744
This ensures every PR has proper changelog documentation before merge.
3845

0 commit comments

Comments
 (0)