patch-git: Update CONTRIBUTING.md (RHEL-167871)

This commit updates CONTRIBUTING.md, correcting several details about
how patch-git treats various git trailers.

Resolves: RHEL-167871
RPM-Skip-Release: yes
This commit is contained in:
Arjun Shankar 2026-08-03 01:18:51 +02:00 committed by Frédéric Bérat
parent 7cd0eca44e
commit 3aadd3fdf3

View File

@ -44,13 +44,15 @@ be separated from the message body by a blank line. See
[git-interpret-trailers](https://git-scm.com/docs/git-interpret-trailers)
for the format details.
A `Resolves:` or `Related:` tag is required to be present in the
trailer. Incorrectly formatted Git commit messages will lead to build
failures. Running `centpkg srpm` locally is sufficient for performing
the format checks.
Incorrectly formatted Git commit messages or unrecognized trailers will lead
to build failures. Running `centpkg srpm` locally is sufficient for
performing the format checks.
For tags that accept boolean values, `yes`/`no`, `true`/`false`, `1`/`0`
are recognized.
Although a `Resolves:` or `Related:` tag is required to be present in the
trailer, this is currently not enforced via a check.
For tags that accept boolean values, `yes`/`no` and `true`/`false` (both
case-sensitive) as well as `1`/`0` are recognized.
The following `Key: value` pairs are recognized.
@ -61,8 +63,8 @@ The following `Key: value` pairs are recognized.
```
Resolves: RHEL-110535, RHEL-110949
```
One of these tags must be present in every commit. The patch
management tooling treats both tags as equivalent.
One of these tags must be present in every commit, although not enforced
by tooling.
* `Parent`. The 40-character hash of the parent commit. Required when
using `RPM-Release` or `RPM-Changelog-Stop`. Building fails if the
@ -108,10 +110,10 @@ The following `Key: value` pairs are recognized.
* `RPM-Changelog-Stop`. Boolean. When `yes`, generation
of changelog entries stops at this commit. Requires `Parent`.
* `RPM-Version`. Explict RPM version string. Must be a single word.
RPM macros are not permitted (no `%`). Requires `Parent`. If the
RPM version is not specified in a commit, it remains the same as in
its parent commit.
* `RPM-Version`. Explict RPM version string. Must be a single word that
contains at least one decimal digit and does not contain a `-` or an RPM
macro (i.e. no `%`). Requires `Parent`. If the RPM version is not
specified in a commit, it remains the same as in its parent commit.
* `RPM-Release`. Explicit RPM release string. Must be a single word
that contains `%{?dist}`, includes at least one digit, and does not
@ -123,7 +125,7 @@ The following `Key: value` pairs are recognized.
`.1` at the end of the release, but increment the release as usual.
If `RPM-Release` is omitted, the RPM release is generated from the
parent commit, by incrementing the left-most number in its release
parent commit, by incrementing the right-most number in its release
string. (Special case: branch switching, as described above under
`RPM-Branch-Type`.)