Skip to content

Latest commit

 

History

History
24 lines (19 loc) · 1.18 KB

CONTRIBUTING.md

File metadata and controls

24 lines (19 loc) · 1.18 KB

Contributing to FireMarshal

Contributing Changes

We welcome contributions to FireMarshal through github PRs. All PRs should be against the master branch.

Before submitting a PR:

  • Merge origin/master to ensure you have the latest changes.

  • Run ./fullTest.py to ensure the basic unit-tests still work

  • Ensure all code passes lint (this will be enforced by github). You can manually check each file (or a glob) with the following command:

    pylama --ignore="E501" --linters="pycodestyle,pyflakes" FILENAME.py

Getting Help / Discussion:

Branch management:

  1. tagged releases: All stable releases are tagged and tracked with githubs releases mechanism.
  2. master: Unstable development. Master should work at all times, but there are no guarantees that bugs haven't been introduced.
  3. All other branches: Private development branches, typically not suitable for use.