doc/source/contribute.rst

   1 Contributing
   2 =============
   3
   4 Use git, `learn if needed`_.
   5
   6 Git Workflow
   7 -------------
   8 * ``master`` branch holds latest stable|release code
   9 * ``dev`` branch holds current development code
  10 * Work on a dedicated branch starting off ``dev``
  11 * I like fast forward merges, **please rebase on** ``dev`` branch before submitting changes
  12 * Advertise your work (cf. Note)
  13
  14 .. NOTE::
  15     **Git merge Workflow** |br|
  16     I currently don't care about a specific workflow concerning changes submission. |br|
  17     Don't bother with gitlab merge request or gh pull request. |br|
  18     All we need is a public git repo and a ref to fetch from as long you rebased on ``dev`` branch.
  19
  20 Coding
  21 -------
  22
  23 * follow pep8
  24 * actually test your code (unit and functional testing)
  25 * write unittest
  26
  27
  28 .. _`learn if needed`: https://git-scm.com/book/
  29
  30 .. |br| raw:: html
  31
  32     <br />
  33
  34 .. vim: spell spelllang=en