diff options
author | Robin Jarry <robin@jarry.cc> | 2023-05-28 18:05:32 +0200 |
---|---|---|
committer | Robin Jarry <robin@jarry.cc> | 2023-05-30 09:43:21 +0200 |
commit | ac43047d4508b7f375fe6808f8e4826a1ef40210 (patch) | |
tree | 96817e78203ba5677fe3a74a517eb4bb3afa16ac | |
parent | df9ffb6a000a5d035fdcb8385aaf0deb3402021a (diff) | |
download | aerc-ac43047d4508b7f375fe6808f8e4826a1ef40210.tar.gz |
contributing: cleanup
Remove outdated information. Add wiki specific instructions.
Signed-off-by: Robin Jarry <robin@jarry.cc>
-rw-r--r-- | CONTRIBUTING.md | 11 |
1 files changed, 7 insertions, 4 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 55352e59..fc96e9ab 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -23,10 +23,7 @@ that you did not break anything. *Unreleased* section of the [CHANGELOG.md](https://git.sr.ht/~rjarry/aerc/tree/master/item/CHANGELOG.md) file. -- Run the linter using `make lint`. If notmuch is not available on your system - you may have to edit `.golangci.toml` and disable the notmuch tag. [Otherwise - you could get hard to trace false - positives](https://github.com/golangci/golangci-lint/issues/3061) +- Run the linter using `make lint`. Once you are happy with your work, you can create a commit (or several commits). Follow these general rules: @@ -76,6 +73,12 @@ instructions][git-send-email-tutorial]): $ git send-email --annotate -1 +If you are sending a patch against the `wiki` branch, make sure to change the +subject prefix to avoid triggering the automated builds that will inevitably +fail: + + $ git send-email --annotate -1 --subject-prefix="PATCH aerc/wiki" + Before your patch can be applied, it needs to be reviewed and approved by others. They will indicate their approval by replying to your patch with a [Tested-by, Reviewed-by or Acked-by][linux-review] (see also: [the git |