diff options
| author | Robin Jarry <robin@jarry.cc> | 2022-12-14 15:20:35 +0100 |
|---|---|---|
| committer | Robin Jarry <robin@jarry.cc> | 2022-12-14 22:17:19 +0100 |
| commit | 86eed28e65aed43a4b017f758405ca85fd74bf21 (patch) | |
| tree | 7619ffc4042834365a53ba748af27932be1dd325 /CONTRIBUTING.md | |
| parent | 4fe27144e3e78108b9ead03a256d1f7cf3e85557 (diff) | |
| download | aerc-86eed28e65aed43a4b017f758405ca85fd74bf21.tar.gz | |
contributing: add tooling for git send-email
Add a gitconfig target in the Makefile to configure a new clone with
sane defaults:
- set subject prefix
- set correct mailing list address
- enable sendemail.validate
- install sendemail-validate hook
The sendemail-validate hook will make a shallow clone of the current
upstream repo, apply every patch on it and run some checks (a stripped
down version of what is run by the upstream CI).
Add a new check-patches script that verifies that the commit message
actually contains something and that the Signed-off-by trailer from the
patch author is present.
Call check-patches in both the CI and the sendemail-validate hook.
Update CONTRIBUTING.md accordingly.
Signed-off-by: Robin Jarry <robin@jarry.cc>
Acked-by: Tim Culverhouse <tim@timculverhouse.com>
Diffstat (limited to 'CONTRIBUTING.md')
| -rw-r--r-- | CONTRIBUTING.md | 7 |
1 files changed, 5 insertions, 2 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 44a567be..dc8f17cb 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -65,8 +65,11 @@ example: Before sending the patch, you should configure your local clone with sane defaults: - $ git config format.subjectPrefix "PATCH aerc" - $ git config sendemail.to "~rjarry/aerc-devel@lists.sr.ht" + $ make gitconfig + git config format.subjectPrefix "PATCH aerc" + git config sendemail.to "~rjarry/aerc-devel@lists.sr.ht" + git config sendemail.validate true + ln -sf ../../contrib/sendemail-validate .git/hooks/sendemail-validate And send the patch to the mailing list ([step by step instructions][git-send-email-tutorial]): |