That looks really good! My one nit is that it should mention that CI
won't run unless the patches start with a subject of '[PATCH
merge-rs]'. Right now it looks like '[merge-rs]' will work fine, and
there's nothing clearly tying it to builds.
Thanks for the review! True, this section is not very precise. I
didn’t want to mention the prefix again because it only applies for the
shared mailing lists. But I’ll see whether I can somehow improve this
section. Ideally, I’d link to the sourcehut documentation for this
feature, but as it was added rather recently, so there is not yet much
documentation to refer to. ^^
Also, the PATCH prefix is not only necessary for triggering the builds.
It also enables the patch view in the web interface:
Maybe I should explain this in the Submitting Patches section.
README.md | 8 ++++++++
1 file changed, 8 insertions(+)
diff --git a/README.md b/README.md
index 1bdb16a..322491e 100644
--- a/README.md+++ b/README.md
@@ -82,6 +82,14 @@ For bug reports, patches, feature requests and other messages, please send a
mail to [~email@example.com] using the `[merge-rs]` prefix in
+You can submit patches using+[`git send-email --firstname.lastname@example.org`][git-send-email].+ Please prefix the subject with `PATCH merge-rs` so that CI will be+automatically run. You can configure git to do this automatically with+`git config format.subjectPrefix "PATCH merge-rs"`.++[git-send-email]: https://git-send-email.io+## License
This project is dual-licensed under the [Apache-2.0] and [MIT] licenses.
I wrote a general contributing guide for my projects on Sourcehut that
I’d like to link in the merge-rs readme. Could you please have a look
and check whether anything is unclear or missing? Thanks!