summaryrefslogtreecommitdiffstats
path: root/CONTRIBUTING
diff options
context:
space:
mode:
authorAlejandro Colomar <alx@kernel.org>2022-11-22 20:29:48 +0100
committerAlejandro Colomar <alx@kernel.org>2022-11-22 20:29:48 +0100
commite2b3164c1912088e0fe7bab361a855b9eb4f6363 (patch)
tree8de7fb7ce8e8a493cf3ee1d1702af21fc998be8f /CONTRIBUTING
parente5381b411d73dede34895c33b453620d01e596bb (diff)
CONTRIBUTING: Move style guide to description
Signed-off-by: Alejandro Colomar <alx@kernel.org>
Diffstat (limited to 'CONTRIBUTING')
-rw-r--r--CONTRIBUTING18
1 files changed, 10 insertions, 8 deletions
diff --git a/CONTRIBUTING b/CONTRIBUTING
index 59d980271..1a0d16f64 100644
--- a/CONTRIBUTING
+++ b/CONTRIBUTING
@@ -2,7 +2,7 @@ Name
Contributing - instructions for contributing to the project
Synopsis
- Mailing list, patches, and bug reports.
+ Mailing list, patches, lint, style guide, bug reports, and notes
Description
Mailing list
@@ -162,6 +162,15 @@ Description
If you can't meet them all, don't worry; it will still run the linters
that you have available.
+ Style guide
+ For a description of the preferred layout of manual pages, as well as
+ some style guide notes, see:
+
+ $ man 7 man-pages
+
+ It will also be interesting to consult groff_man(7) and
+ groff_man_style(7) for understanding and writing good man(7) source code.
+
Reporting bugs
Report bugs to the mailing list, following the instructions above for
sending mails to the list. If you can write a patch (see instructions
@@ -182,13 +191,6 @@ Reporting bugs
There's also a bugzilla, but we don't use it as much as the mailing list.
Notes
- For a description of the preferred layout of manual pages, as well as
- some style guide notes, see:
-
- $ man 7 man-pages
-
- It will also be interesting to consult groff_man(7) and
- groff_man_style(7) for understanding and writing good man(7) source code.
Bugs
Bugzilla: