Skip to content

State the general changelog rule in AGENTS.md #1010

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 4 commits into from
Oct 8, 2026
Merged

State the general changelog rule in AGENTS.md #1010

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
7301208
State the general changelog rule in AGENTS.md
moCello Oct 7, 2026
1b2e544
Point CONTRIBUTING.md to the changelog rule in AGENTS.md
moCello Oct 7, 2026
0e745a7
Remove changelog entries that users cannot see
moCello Oct 7, 2026
4983043
Shorten the changelog section in AGENTS.md
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
8 changes: 8 additions & 0 deletions AGENTS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -71,3 +71,11 @@ Changes to plonk ripple to downstream crates — `phoenix/circuits`, `poseidon-m

**Branches**: branch from `master`. Don't push to `master` directly.
**Commits**: follow the style of recent commits in the repo.

## Changelog

Update `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.
14 changes: 0 additions & 14 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,12 +22,6 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
- Add `Error::CircuitUnsatisfied` [#877]
- Add `Display` for `Error` to builds without the `std` feature [#895]
- Add `core::error::Error` for `Error` to builds without the `std` feature [#895]
- Cover curve-addition poles directly in point soundness regressions and update
their module documentation [#910]
- Isolate the collapsed curve-addition pole residual in a point soundness
regression [#914]
- Cover the positive curve-addition pole with an isolated soundness regression
[#916]

### Changed

Expand Down Expand Up @@ -67,11 +61,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
and commitment keys [#964]
- Bind proof construction to the public-input rows recorded at compile time [#957]
- Reject serialized provers that predate the compiled public-input row layout [#957]
- Update Criterion to 0.8 and align the dev-only `itertools` dependency [#953]
- Raise the MSRV to Rust 1.96.1 [#951]
- Update `blake2b_simd` to 1.0.5 [#950]
- Replace the deprecated `tempdir` development dependency with `tempfile`
[#949]
- Update `miniz_oxide` to 0.9 and replace the unmaintained `adler` dependency
with `adler2` [#948]
- Align `hashbrown` with the version used by the optional RKYV dependency graph
Expand Down Expand Up @@ -862,10 +853,8 @@ is necessary since `rkyv/validation` was required as a bound.
[#960]: https://github.com/dusk-network/plonk/issues/960
[#959]: https://github.com/dusk-network/plonk/issues/959
[#957]: https://github.com/dusk-network/plonk/issues/957
[#953]: https://github.com/dusk-network/plonk/issues/953
[#951]: https://github.com/dusk-network/plonk/issues/951
[#950]: https://github.com/dusk-network/plonk/issues/950
[#949]: https://github.com/dusk-network/plonk/issues/949
[#948]: https://github.com/dusk-network/plonk/issues/948
[#943]: https://github.com/dusk-network/plonk/issues/943
[#942]: https://github.com/dusk-network/plonk/issues/942
Expand All @@ -880,10 +869,7 @@ is necessary since `rkyv/validation` was required as a bound.
[#927]: https://github.com/dusk-network/plonk/issues/927
[#920]: https://github.com/dusk-network/plonk/issues/920
[#919]: https://github.com/dusk-network/plonk/issues/919
[#916]: https://github.com/dusk-network/plonk/issues/916
[#914]: https://github.com/dusk-network/plonk/issues/914
[#913]: https://github.com/dusk-network/plonk/issues/913
[#910]: https://github.com/dusk-network/plonk/issues/910
[#908]: https://github.com/dusk-network/plonk/issues/908
[#902]: https://github.com/dusk-network/plonk/issues/902
[#903]: https://github.com/dusk-network/plonk/issues/903
Expand Down
6 changes: 2 additions & 4 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,10 +38,8 @@ other kind of inconsistency with your code.

- Do not open PRs that are not linked or related to a previously opened issue.

- Update the `Unreleased` section of the [CHANGELOG](https://github.com/dusk-network/plonk/blob/master/CHANGELOG.md)
if your PR includes anything that it's worth to be noticed in there. Avoid adding things
like doc-nitpicks and similar changes which do not affect directly any added,
fixed, removed or changed feature.
- Follow the [changelog section of AGENTS.md](AGENTS.md#changelog) to decide on and write
an entry in the [CHANGELOG](https://github.com/dusk-network/plonk/blob/master/CHANGELOG.md).

# Code of Conduct

Expand Down
Loading