Hello Paul, On 8/7/19 3:50 AM, Paul Wise wrote: > Written-by: Michael Kerrisk <mtk.manpages@xxxxxxxxx> > --- > CONTRIBUTING | 16 ++++++++++++++++ > 1 file changed, 16 insertions(+) > create mode 100644 CONTRIBUTING > > diff --git a/CONTRIBUTING b/CONTRIBUTING > new file mode 100644 > index 000000000..db947b5af > --- /dev/null > +++ b/CONTRIBUTING > @@ -0,0 +1,16 @@ > +Commit style: > + > +When referring to Linux kernel versions, please add a > +comment before it that shows the kernel commit hash. > + > +Use .PP rather than blank lines as paragraph separators. > + > +Starting new sentences on new source lines makes future patches against > +the source easier to grok. This is known as semantic newlines: > + > +https://rhodesmill.org/brandon/2012/one-sentence-per-line/ > + > +Sending patches: > + > +To: Michael Kerrisk (man-pages) <mtk.manpages@xxxxxxxxx> > +CC: linux-man@xxxxxxxxxxxxxxx Pretty much all of the above is covered either on the project website, or in man-pages(7). (I just added a note to man-pages(7) about avoiding blank lines as separators, and further enhanced the discussion of semantic newlines.) But of course, your meta-point is: let's make things more visible. I instead added a CONTRIBUTING file as below. Thanks for the idea! Cheers, Michael diff --git a/CONTRIBUTING b/CONTRIBUTING new file mode 100644 index 000000000..383bae5b3 --- /dev/null +++ b/CONTRIBUTING @@ -0,0 +1,13 @@ +For general information about how to contribute, see: +https://www.kernel.org/doc/man-pages/contributing.html + +For information on how to send patches, see: +https://www.kernel.org/doc/man-pages/patches.html + +For a description of the preferred layout of manual pages, +as well as some style guide notes, see: + + $ man 7 man-pages + +For information about reporting bugs, see: +https://www.kernel.org/doc/man-pages/reporting_bugs.html -- Michael Kerrisk Linux man-pages maintainer; http://www.kernel.org/doc/man-pages/ Linux/UNIX System Programming Training: http://man7.org/training/
