doc/source/contribute.rst

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