diff options
| author | Bence Ferdinandy <bence@ferdinandy.com> | 2024-01-17 14:02:19 +0100 |
|---|---|---|
| committer | Robin Jarry <robin@jarry.cc> | 2024-01-18 22:07:21 +0100 |
| commit | 9a255ab5b7bc8c85b990cf9a290fc3a1ff3b7ce4 (patch) | |
| tree | 195a14f859915c46cef7a405f5736df5029194ec /CONTRIBUTING.md | |
| parent | cefdce3f82b8a477a74f573b86df8c7f2c1017a8 (diff) | |
| download | aerc-9a255ab5b7bc8c85b990cf9a290fc3a1ff3b7ce4.tar.gz | |
check-patches: enforce trailer list
With the new Changelog-*: trailers it's important that trailers are not
misspelled accidentally and to cut down on trailer clutter. Add an
explicit list of accepted trailers with their preferred ordering and
some explanation where warranted to CONTRIBUTING. Enforce the list in
CI.
Signed-off-by: Bence Ferdinandy <bence@ferdinandy.com>
Reviewed-by: Moritz Poldrack <moritz@poldrack.dev>
Acked-by: Robin Jarry <robin@jarry.cc>
Diffstat (limited to 'CONTRIBUTING.md')
| -rw-r--r-- | CONTRIBUTING.md | 28 |
1 files changed, 28 insertions, 0 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 6c9df2c7..756cd1bb 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -57,6 +57,34 @@ commits). Follow these general rules: indenting extra lines with a single space. The trailer text must be valid markdown. You can take inspiration from existing entries in [CHANGELOG.md](https://git.sr.ht/~rjarry/aerc/tree/master/item/CHANGELOG.md). +- The following trailers are accepted in commits. If you are using multiple + trailers in a commit, it's preferred to also order them according to this + list. Note, that the `commit-msg` hook (see below for installing) will + automatically sort them for you when committing. + + * `Closes: <URL>` closes the ticket with the neutral `CLOSED` resolution. + * `Fixes: <URL>` closes the ticket with the `FIXED` resolution. + * `Fixes: <sha> ("<title>")` reference the commit that introduced a regression. + * `Implements: <URL>` closes the ticket with the `IMPLEMENTED` resolution. + * `References: <URL>` adds a comment to the ticket. + * `Link:` + * `Changelog-added:` + * `Changelog-fixed:` + * `Changelog-changed:` + * `Changelog-deprecated:` + * `Cc:` + * `Suggested-by:` + * `Requested-by:` + * `Reported-by:` + * `Co-authored-by:` + * `Signed-off-by:` compulsory! + * `Tested-by:` used in review _after_ submission to the mailing list. If + minimal changes occur between respins, feel free to include that into your + respin to keep track of previous reviews. + * `Reviewed-by:` used in review _after_ submission. If minimal changes occur + between respins, feel free to include that into your respin to keep track + of previous reviews. + * `Acked-by:` used in review _after_ submission. There is a great reference for commit messages in the [Linux kernel documentation](https://www.kernel.org/doc/html/latest/process/submitting-patches.html#describe-your-changes). |