1
0
mirror of https://github.com/sharkdp/bat.git synced 2025-03-15 15:18:45 +00:00

Clarify when changelog entries are necessary

This commit is contained in:
einfachIrgendwer0815 2024-02-11 10:46:28 +01:00
parent a0941b02f1
commit fec17a1364
No known key found for this signature in database
GPG Key ID: 58D55E5F117DA873

View File

@ -6,10 +6,31 @@ Thank you for considering to contribute to `bat`!
## Add an entry to the changelog ## Add an entry to the changelog
If your contribution changes the behavior of `bat` (as opposed to a typo-fix Keeping the [`CHANGELOG.md`](CHANGELOG.md) file up-to-date makes the release
in the documentation), please update the [`CHANGELOG.md`](CHANGELOG.md) file process much easier and therefore helps to get your changes into a new `bat`
and describe your changes. This makes the release process much easier and release faster. However, not every change to the repository requires a
therefore helps to get your changes into a new `bat` release faster. changelog entry. Below are a few examples of that.
Please update the changelog if your contribution contains changes regarding
any of the following:
- the behavior of `bat`
- syntax mappings
- syntax definitions
- themes
- the build system, linting, or CI workflows
A changelog entry is not necessary when:
- updating documentation
- fixing typos
>[!NOTE]
> For PRs, a CI workflow verifies that a suitable changelog entry is
> added. If such an entry is missing, the workflow will fail. If your
> changes do not need an entry to the changelog (see above), that
> workflow failure can be disregarded.
### Changelog entry format
The top of the `CHANGELOG` contains a *"unreleased"* section with a few The top of the `CHANGELOG` contains a *"unreleased"* section with a few
subsections (Features, Bugfixes, …). Please add your entry to the subsection subsections (Features, Bugfixes, …). Please add your entry to the subsection