[GNUnet-SVN] [gnunet] 36/41: contributing

[gnunet]

This is an automated email from the git hooks/post-receive script.

ng0 pushed a commit to branch master
in repository gnunet.

commit 89e601bc4a649f7cbe4c52777877a89692d8c7f2
Author: ng0 <address@hidden>
AuthorDate: Tue Nov 14 13:55:08 2017 +0000

    contributing
---
 doc/documentation/chapters/contributing.texi | 44 ++++++++++++++++++++++++++++
 1 file changed, 44 insertions(+)

diff --git a/doc/documentation/chapters/contributing.texi 
b/doc/documentation/chapters/contributing.texi
index a2b21df4c..c077ea3f3 100644
--- a/doc/documentation/chapters/contributing.texi
+++ b/doc/documentation/chapters/contributing.texi
@@ -53,3 +53,47 @@ in the respective authors file or section, please do let us 
know.
 @node Contributing to the Reference Manual
 @section Contributing to the Reference Manual
 
address@hidden @bullet
+
address@hidden When writing documentation, please use
address@hidden://en.wikipedia.org/wiki/Singular_they, gender-neutral wording}
+when referring to people, such as singular “they”, “their”, “them”, and so
+forth.
+
address@hidden Keep line length below 74 characters, except for URLs.
+URLs break in the PDF output when they contain linebreaks.
+
address@hidden Do not use tab characters (see chapter 2.1 texinfo manual)
+
address@hidden Use neutral language and third person perspective in the text
+
address@hidden So, when you refer to a user in general or addressing the user,
+refer to (1).
address@hidden @bullet
address@hidden Unsolved exceptions for canonical reasons: When refering to 
Alice,
+use "she". When refering to Bob, use "he". These are long established
+examples and they should either be replaced (avoid Alice and Bob
+examples when you can) or followed.
address@hidden itemize
+
address@hidden Use 2 spaces between sentences, so instead of:
+
address@hidden
+We do this and the other thing. This is done by foo.
address@hidden example
+
+Write:
+
address@hidden
+We do this and the other thing.  This is done by foo.
address@hidden example
+
address@hidden Use @@address@hidden@} instead of putting an @@address@hidden@} 
to the
+footnote on a collected footnote-page.
+In a 200+ pages handbook it's better to have footnotes accessible
+without having to skip over to the end.
+
address@hidden Avoid unnecessary footnotes, keep the text self-explanatory and
+in a simple language where possible/necessary.
+
address@hidden itemize

-- 
To stop receiving notification emails like this one, please contact
address@hidden