git.r.bdr.sh - rbdr/junction/blob - CONTRIBUTING.md

   1 # Contributing to Junction
   2
   3 At this moment Junction is more of a hobby project and we want to keep the
   4 scope and feature set small, however bugfixes and improvements are appreciated!
   5
   6 ## Types of contribution that are welcome
   7
   8 - Bugfixes
   9 - Reliability improvements
  10 - Tests
  11 - Tooling improvements
  12
  13 For other type of contributions, such as new features, please make proposals
  14 in the [junction-devel][junction-devel] mailing list first.
  15
  16 ## How to contribute
  17
  18 Above All: Be nice, always.
  19
  20 Before submitting a patch, make sure:
  21
  22 - You run `make format` before submitting.
  23 - Make sure you test the work.
  24
  25 ## How to send patches
  26
  27 Send the patch to the [junction-devel][junction-devel] mailing list. See
  28 [git-send-email.io][git-send-email] for more information on how.
  29
  30 [junction-devel]: https://lists.sr.ht/~rbdr/junction-devel
  31 [git-send-email]: https://git-send-email.io/