docs/hacking/contributing

   1
   2                 Contributing to Link
   3                         or
   4         How to not make Levi or Ariston go *insane*
   5
   6 =================================================================
   7
   8 This is just a simple little CONTRIBUTING document for Link.
   9 There isn't any need for this document to be fully detailed and
  10 all that since we're more relaxed here since Link is a way
  11 smaller project than Inferno.
  12
  13 1. MAKE SEPARATE COMMITS FOR LOGICALLY SEPARATE CHANGES.
  14
  15         A good way to test this is to always write descriptions in
  16         your commits about the technical details (this helps the
  17         maintainers anyways).
  18
  19         If your description starts to get long, it should serve
  20         as a clear sign that probably should be splitting up
  21         your patch into smaller patches.
  22
  23 2. SIGN YOUR WORK
  24
  25         We're borrowing using "Signed-off-by" from Linux which
  26         helps track who exactly did what and who approved a
  27         change. Although Link is a smaller project, it's just
  28         general good discipline to follow this.
  29
  30         The "Signed-off-by" line sits at the end of a commit
  31         message of the patch which certifies that you have wrote
  32         the patch.
  33
  34         To do this, you can just add a line at the end of your
  35         commit saying:
  36
  37                 Signed-off-by: John Doe <johnd@n11.dev>
  38
  39         using a known identity (we prefer no anonymous
  40         contributions). This also can be automatically done for
  41         you if you use Git by running:
  42
  43                 $ git commit -s
  44
  45 3. CODING STYLE
  46
  47         The coding style is same across all N11 projects (except
  48         projects mainly led solely by Ariston Lorenzo). A copy of
  49         the coding style can be found in the source tree of
  50         Hydra/Inferno.
  51
  52 4. USE PATCHES
  53
  54         Although nowadays, people are more accustomed to the
  55         world of GitHub pull requests, etc., we prefer to use
  56         patches via email as with other N11 projects. PRs won't
  57         be able to scale well with our codebases.
  58
  59         For info on actually working on Link and dealing with
  60         patches, see docs/patchwork
  61
  62         Obviously, since most people aren't accustomed to this,
  63         feel free to use pull requests. But if possible, please
  64         use patches :^).