Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
23 lines (12 loc) · 888 Bytes

CONTRIBUTING.md

File metadata and controls

23 lines (12 loc) · 888 Bytes

Contribution Guide

General workflow:

  1. Fork repo
  2. Setup mirrored repo optional
  3. Create new branch using source branch development
  4. Create Merge Request to source repo branch development branch from your new-branch mark to remove branch on merge
  5. Start contributing.
❗ Tip
keep your forked repo up to date by setting up mirroring Repository Settings -> Mirroring repositories. Then setup to pull only protect branches.

to setup the dev environment run . ./develop.sh from the root of the reository. This command creates a python virtual environment on which you can work from. cz commit is also available so that you can always commit with correctly formated commit messages.

if your uncertain, please ask, tag @jon_nfc.