Skip to content

README.md

Latest commit

 

History

History
42 lines (31 loc) · 1.6 KB

README.md

File metadata and controls

42 lines (31 loc) · 1.6 KB
Raw

Changelog Fragments

The changelog helps developers keep track of the changes happening across the codebase. All PRs, other than those which are purely "chore" tasks (e.g. formatting, typos) should include a changelog entry. The changelog is NOT limited to only user-facing changes.

Instead of editing CHANGELOG.md directly, each PR should add a fragment file to this directory. This avoids merge conflicts and makes the release process clearer. Each fragment should be one or more complete sentences. Each line in the fragment file will become a separate bullet point in the final CHANGELOG.md.

How to add a changelog entry

  1. Create a file in this directory named: <short-description>.<category>

    Categories: added, changed, fixed, removed

    Examples:

    • marf-compress.added
    • tenure-mining-fix.fixed
    • remove-deprecated-rpc.removed

  2. Write the changelog entry text in the file (one or more lines of markdown):

    Added `marf_compress` as a node configuration parameter to enable MARF compression feature ([#6811](https://github.com/stacks-network/stacks-core/pull/6811))

  3. That's it. The fragment will be assembled into CHANGELOG.md at release time using contrib/tools/assemble-changelog.sh.

Notes

  • One fragment per PR is typical, but you can add multiple if your PR spans categories.
  • If your PR doesn't need a changelog entry (e.g., docs-only, CI changes, test-only), you can skip this. Add the no changelog label to your PR to bypass the CI check.
  • Fragment files are deleted after they are assembled into the changelog during a release.