Skip to content

State the general changelog rule in AGENTS.md #60

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
moCello merged 2 commits into from
Oct 8, 2026
Merged

State the general changelog rule in AGENTS.md #60

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5f4d13d
workspace: State the general changelog rule
moCello Oct 8, 2026
6933104
workspace: Shorten the changelog section
moCello Oct 8, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions AGENTS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -86,8 +86,8 @@ Examples:

### Changelog

Both crates have a `CHANGELOG.md`. Add entries to the affected crate under
`[Unreleased]` using [Keep a Changelog](https://keepachangelog.com/) format. If
a change traces to a GitHub issue, reference it as a link:
`[#42](https://github.com/dusk-network/dusk-bytes/issues/42)`. Only link to
GitHub issues — do not reference any other tracking system.
Update a crate's `CHANGELOG.md` under `[Unreleased]` for user-visible changes only. Exclude tests, CI, tooling, and refactors.

- One fact per entry. Name the public item and behavior, including the affected released item if breaking. Leave implementation, rationale, consequences, and migration to the linked issue.
- Use existing `Added`, `Changed`, or `Removed` sections. Use `Fixed` only for released bugs. Correct unreleased bugs in their original entry.
- Link only the GitHub issue, not the PR. Match existing link style and define references below. Preserve other entries and follow [Keep a Changelog](https://keepachangelog.com/en/1.0.0/) and Markdown blank-line spacing.