diff options
| author | Bence Ferdinandy <bence@ferdinandy.com> | 2024-01-17 14:02:18 +0100 |
|---|---|---|
| committer | Robin Jarry <robin@jarry.cc> | 2024-01-18 22:07:21 +0100 |
| commit | cefdce3f82b8a477a74f573b86df8c7f2c1017a8 (patch) | |
| tree | d0ee7bee9a3e1f08615305d9a6a88fb84e48bf9c /CONTRIBUTING.md | |
| parent | 51ec0159ec8c51e6bcba9a420de776f4738f02eb (diff) | |
| download | aerc-cefdce3f82b8a477a74f573b86df8c7f2c1017a8.tar.gz | |
check-patches: enforce prose on changelog entries
Check if the Changelog-*: trailers have proper English sentences
starting with a capital letter and ending in a period. Update
CONTRIBUTING with an explicit mention of this.
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 | 4 |
1 files changed, 3 insertions, 1 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 1a4d0bd2..6c9df2c7 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -44,7 +44,9 @@ commits). Follow these general rules: trailer with the commit id and its title. - When in doubt, follow the format and layout of the recent existing commits. - If your commit brings visible changes for end-users, add one of the following - trailers with a short and concise description of the change. + trailers with a short and concise description of the change. The change + should be described in full sentences, starting with a capital letter and + ending in a period. * `Changelog-added:` for new features. * `Changelog-fixed:` for bug fixes. |