about summary refs log tree commit diff
path: root/src/inc/pyonji.md
diff options
context:
space:
mode:
authorRobert Günzler <r@gnzler.io>2025-01-08 11:52:11 +0100
committerRobert Günzler <r@gnzler.io>2025-01-13 14:12:08 +0100
commitf906fa87e95371a5f412ab0a44502cdc652e80be (patch)
treecb5496fb32f0106219de3887d64b5780a850b0b2 /src/inc/pyonji.md
parente2682bfe2c9a36b9b93769f7338212d0ae2b31cb (diff)
downloadsite-f906fa87e95371a5f412ab0a44502cdc652e80be.tar.gz
add pyonji page
Signed-off-by: Robert Günzler <r@gnzler.io>
Diffstat (limited to '')
-rw-r--r--src/inc/pyonji.md26
1 files changed, 26 insertions, 0 deletions
diff --git a/src/inc/pyonji.md b/src/inc/pyonji.md
new file mode 100644
index 0000000..8f55983
--- /dev/null
+++ b/src/inc/pyonji.md
@@ -0,0 +1,26 @@
+---
+date: 2025-01-08
+---
+
+[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:
+
+1. ensure th [to address] is set (or pass `--to`)   
+   `git config --local sendemail.to`
+
+2. use `origin/master` or `HEAD~n` for the `--base` option, this determines what 
+   is included in the patch series
+
+3. when sending to a public-inbox style list, ensure the [subject prefix] is set  
+   `git config --local format.subjectprefix`
+
+4. when writing the cover letter, note that the first paragraph is parsed as the
+   subject of the patch series, see [--cover-from-description]
+
+
+[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