about summary refs log tree commit diff
path: root/src/inc/pyonji.md
blob: 953941fcb094b0bce7abff03792b683cebe901fb (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
---
date: 2025-01-08
---

# Sending patches with Pyonji

[pyonji] is a useful tool to send patches to mailing lists, to contribute to
projects hosted on [sr.ht] for example. It is a friendly TUI alternative to
using `git-send-email` directly, but there are still some essentials to note:

- [ ] ensure th [to address] is set (or pass `--to`)   
   `git config --local sendemail.to`

- [ ] use `origin/master` or `HEAD~n` for the `--base` option, this determines what 
   is included in the patch series

- [ ] when sending to a public-inbox style list, ensure the [subject prefix] is set  
   `git config --local format.subjectprefix`

- [ ] when writing the cover letter, note that the first paragraph is parsed as the
   subject of the patch series, see [--cover-from-description]


I keep a branch with some convenience patches on top of upstream, that make
working with it easier for me: https://git.sr.ht/~robertgzr/pyonji/log/devel

[pyonji]: https://git.sr.ht/~emersion/pyonji
[sr.ht]: https://sr.ht/projects
[to address]: https://git-scm.com/docs/git-config/2.22.1#Documentation/git-config.txt-formatsubjectPrefix
[subject prefix]: https://git-scm.com/docs/git-config/2.22.1#Documentation/git-config.txt-formatsubjectPrefix
[--cover-from-description]: https://git-scm.com/docs/git-format-patch#Documentation/git-format-patch.txt---cover-from-descriptionltmodegt