commit 8366503

delthas  ·  2023-07-09 11:28:04 +0000 UTC
parent 3f89818
doc: Clarify contributing instructions
1 files changed,  +19, -3
+19, -3
 1@@ -43,12 +43,28 @@ things out with an IRC server, then you have two options:
 2 2. Run the test client, that uses the same IRC library but exposes a simpler
 3    interface, by running `go run ./cmd/test -help`.
 4 
 5-## Contributing and stuff
 6-
 7-Contributions are accepted as patches to [the mailing list][ml].
 8+## Issue tracker
 9 
10 Browse tickets at <https://todo.sr.ht/~taiite/senpai>.
11 
12+## Contributing
13+
14+Sending patches to senpai is done [by email](https://lists.sr.ht/~delthas/senpai-dev), this is simple and built-in to Git.
15+
16+Set up your system once by following the steps Installation and Configuration of [git-send-email.io](https://git-send-email.io/)
17+
18+Then, run once in this repository:
19+```shell
20+git config sendemail.to "~delthas/senpai-dev@lists.sr.ht"
21+```
22+
23+Then, to send a patch, make your commit, then run:
24+```shell
25+git send-email --base=HEAD~1 --annotate -1 -v1
26+```
27+
28+It should then appear on [the mailing list](https://lists.sr.ht/~delthas/senpai-dev/patches).
29+
30 ## License
31 
32 This senpai is open source! Please use it under the ISC license.