Skip to content
Merged
Show file tree
Hide file tree
Changes from 3 commits
Commits
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
14 changes: 14 additions & 0 deletions AGENTS.md
Original file line number Diff line number Diff line change
Expand Up @@ -71,3 +71,17 @@ 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

Add an entry to `CHANGELOG.md` under `[Unreleased]` only for a change that users of the crate can see. Tests, CI, tooling and internal refactors get no entry.

- Write one fact per entry, in one sentence. Two facts get two entries.
- Name what changed at the crate's surface: the public item and its new behavior. Do not describe how the code does it.
- Name the released item that a breaking change breaks.
- Keep the reason, the consequences and the migration steps in the linked issue, not in the entry.
- Choose the section by the effect on users: new things go under `Added`, changed behavior goes under `Changed`, and removed things go under `Removed`. Use `Fixed` only for a bug that a release had. For a bug in unreleased code, correct the entry that added that code.
- Link the tracking GitHub issue, not the PR, and no other tracking identifier. Use the link format that the file already uses. A reference link needs its definition in the block at the bottom.
- Add to the existing section headings, and leave the other entries as they are.
- Use the [Keep a Changelog](https://keepachangelog.com/en/1.0.0/) format.
- Follow standard markdown formatting: separate headings from surrounding content with blank lines, leave a blank line before and after lists, and never have two headings back-to-back without a blank line between them.
Comment thread
moCello marked this conversation as resolved.
Outdated
14 changes: 0 additions & 14 deletions CHANGELOG.md
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
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