diff options
author | Schanzenbach, Martin <martin.schanzenbach@aisec.fraunhofer.de> | 2017-12-04 17:39:55 +0100 |
---|---|---|
committer | Schanzenbach, Martin <martin.schanzenbach@aisec.fraunhofer.de> | 2017-12-04 17:39:55 +0100 |
commit | d4b252fd73bdda7be51a971ba06a650a1dceb45c (patch) | |
tree | 15026001f43b756e4a86d7ec80f62fc0d9756dea /doc/documentation/chapters/contributing.texi | |
parent | 514dd6f53cb735d0e48f35ddf92eae469c0abc8a (diff) | |
parent | 24a0b84d503375bf66b5df932cd18631cc88cf8d (diff) |
Merge branch 'identity_abe' into identity_oidc
Diffstat (limited to 'doc/documentation/chapters/contributing.texi')
-rw-r--r-- | doc/documentation/chapters/contributing.texi | 102 |
1 files changed, 102 insertions, 0 deletions
diff --git a/doc/documentation/chapters/contributing.texi b/doc/documentation/chapters/contributing.texi new file mode 100644 index 0000000000..5844fb497f --- /dev/null +++ b/doc/documentation/chapters/contributing.texi @@ -0,0 +1,102 @@ +@node GNUnet Contributors Handbook +@chapter GNUnet Contributors Handbook + +@menu +* Contributing to GNUnet:: +* Licenses of contributions:: +* Copyright Assignment:: +* Contributing to the Reference Manual:: +@end menu + +@node Contributing to GNUnet +@section Contributing to GNUnet + +@node Licenses of contributions +@section Licenses of contributions + +GNUnet is a @uref{https://www.gnu.org/, GNU} package. +All code contributions must thus be put under the +@uref{https://www.gnu.org/copyleft/gpl.html, GNU Public License (GPL)}. +All documentation should be put under FSF approved licenses +(see @uref{https://www.gnu.org/copyleft/fdl.html, fdl}). + +By submitting documentation, translations, and other content to GNUnet +you automatically grant the right to publish code under the +GNU Public License and documentation under either or both the +GNU Public License or the GNU Free Documentation License. +When contributing to the GNUnet project, GNU standards and the +@uref{https://www.gnu.org/philosophy/philosophy.html, GNU philosophy} +should be adhered to. + +@cindex copyright assignment +@node Copyright Assignment +@section Copyright Assignment +We require a formal copyright assignment for GNUnet contributors +to GNUnet e.V.; nevertheless, we do allow pseudonymous contributions. +By signing the copyright agreement and submitting your code (or +documentation) to us, you agree to share the rights to your code +with GNUnet e.V.; GNUnet e.V. receives non-exclusive ownership +rights, and in particular is allowed to dual-license the code. You +retain non-exclusive rights to your contributions, so you can also +share your contributions freely with other projects. + +GNUnet e.V. will publish all accepted contributions under the GPLv3 +or any later version. The association may decide to publish +contributions under additional licenses (dual-licensing). + +We do not intentionally remove your name from your contributions; +however, due to extensive editing it is not always trivial to +attribute contributors properly. If you find that you significantly +contributed to a file (or the project as a whole) and are not listed +in the respective authors file or section, please do let us know. + +@node Contributing to the Reference Manual +@section Contributing to the Reference Manual + +@itemize @bullet + +@item When writing documentation, please use +@uref{https://en.wikipedia.org/wiki/Singular_they, gender-neutral wording} +when referring to people, such as singular “they”, “their”, “them”, and so +forth. + +@item Keep line length below 74 characters, except for URLs. +URLs break in the PDF output when they contain linebreaks. + +@item Do not use tab characters (see chapter 2.1 texinfo manual) + +@item Use neutral language and third person perspective in the text + +@item So, when you refer to a user in general or addressing the user, +refer to (1). +@itemize @bullet +@item 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. +@end itemize + +@c FIXME: This is questionable, it feels like bike shed painging to do +@c this for several k lines. It only helps to jump between sentences in +@c editors afaik. +@c @item Use 2 spaces between sentences, so instead of: + +@c @example +@c We do this and the other thing. This is done by foo. +@c @end example + +@c Write: + +@c @example +@c We do this and the other thing. This is done by foo. +@c @end example + +@item Use @@footnote@{@} instead of putting an @@*ref@{@} 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. + +@item Avoid unnecessary footnotes, keep the text self-explanatory and +in a simple language where possible/necessary. + +@end itemize |