doc/documentation/chapters/contributing.texi

   1 @node GNUnet Contributors Handbook
   2 @chapter GNUnet Contributors Handbook
   3
   4 @menu
   5 * Contributing to GNUnet::
   6 * Licenses of contributions::
   7 * Copyright Assignment::
   8 * Contributing to the Reference Manual::
   9 @end menu
  10
  11 @node Contributing to GNUnet
  12 @section Contributing to GNUnet
  13
  14 @node Licenses of contributions
  15 @section Licenses of contributions
  16
  17 GNUnet is a @uref{https://www.gnu.org/, GNU} package.
  18 All code contributions must thus be put under the
  19 @uref{https://www.gnu.org/copyleft/gpl.html, GNU Public License (GPL)}.
  20 All documentation should be put under FSF approved licenses
  21 (see @uref{https://www.gnu.org/copyleft/fdl.html, fdl}).
  22
  23 By submitting documentation, translations, and other content to GNUnet
  24 you automatically grant the right to publish code under the
  25 GNU Public License and documentation under either or both the
  26 GNU Public License or the GNU Free Documentation License.
  27 When contributing to the GNUnet project, GNU standards and the
  28 @uref{https://www.gnu.org/philosophy/philosophy.html, GNU philosophy}
  29 should be adhered to.
  30
  31 @cindex copyright assignment
  32 @node Copyright Assignment
  33 @section Copyright Assignment
  34 We require a formal copyright assignment for GNUnet contributors
  35 to GNUnet e.V.; nevertheless, we do allow pseudonymous contributions.
  36 By signing the copyright agreement and submitting your code (or
  37 documentation) to us, you agree to share the rights to your code
  38 with GNUnet e.V.; GNUnet e.V. receives non-exclusive ownership
  39 rights, and in particular is allowed to dual-license the code. You
  40 retain non-exclusive rights to your contributions, so you can also
  41 share your contributions freely with other projects.
  42
  43 GNUnet e.V. will publish all accepted contributions under the GPLv3
  44 or any later version. The association may decide to publish
  45 contributions under additional licenses (dual-licensing).
  46
  47 We do not intentionally remove your name from your contributions;
  48 however, due to extensive editing it is not always trivial to
  49 attribute contributors properly. If you find that you significantly
  50 contributed to a file (or the project as a whole) and are not listed
  51 in the respective authors file or section, please do let us know.
  52
  53 @node Contributing to the Reference Manual
  54 @section Contributing to the Reference Manual
  55
  56 @itemize @bullet
  57
  58 @item When writing documentation, please use
  59 @uref{https://en.wikipedia.org/wiki/Singular_they, gender-neutral wording}
  60 when referring to people, such as singular “they”, “their”, “them”, and so
  61 forth.
  62
  63 @item Keep line length below 74 characters, except for URLs.
  64 URLs break in the PDF output when they contain linebreaks.
  65
  66 @item Do not use tab characters (see chapter 2.1 texinfo manual)
  67
  68 @item Write texts in the third person perspective.
  69
  70 @c FIXME: This is questionable, it feels like bike shed painging to do
  71 @c this for several k lines. It only helps to jump between sentences in
  72 @c editors afaik.
  73 @c @item Use 2 spaces between sentences, so instead of:
  74
  75 @c @example
  76 @c We do this and the other thing. This is done by foo.
  77 @c @end example
  78
  79 @c Write:
  80
  81 @c @example
  82 @c We do this and the other thing.  This is done by foo.
  83 @c @end example
  84
  85 @item Use @@footnote@{@} instead of putting an @@*ref@{@} to the
  86 footnote on a collected footnote-page.
  87 In a 200+ pages handbook it's better to have footnotes accessible
  88 without having to skip over to the end.
  89
  90 @end itemize