Re: Offline documentation (Org Manual info file) of org hooks is misleading

[Ihor Radchenko]

libreville <libreville@riseup.net> writes:

> Here's my attempt.

Thanks!

> It's my first time doing this, so kindly let me know if there's
> something I can do better!

Generally, we have instructions in 
https://orgmode.org/worg/org-contribute.html#first-patch

> For example, should I have replaced the subject line of this email with
> the subject in the formatted .patch?

Not necessarily. Although, adding [PATCH] to the subject would be
helpful as an indication.

> From c1fda8d0162583db709c90f01df2b8678ddc7957 Mon Sep 17 00:00:00 2001
> From: libreville <libreville@riseup.net>
> Date: Wed, 21 Jun 2023 13:04:19 +0200
> Subject: [PATCH] Delete reference to non-existent examples of hook usage.

1. I'd add "org-manual: ..." to indicate which part of Org is modified.
2. There is no need to end the subject (first) line with "."
3. You need to add TINYCHANGE cookie, unless you have FSF copyright
   assignment.
4. Changelog entry would be good, although this is a simple patch and we
   can skip it here.

Hope it is going to be a good practice :)

-- 
Ihor Radchenko // yantar92,
Org mode contributor,
Learn more about Org mode at <https://orgmode.org/>.
Support Org development at <https://liberapay.com/org-mode>,
or support my work at <https://liberapay.com/yantar92>