Skip to content

Latest commit

 

History

History
36 lines (27 loc) · 1.44 KB

CONTRIBUTING.rst

File metadata and controls

36 lines (27 loc) · 1.44 KB

Implementing New Features

New features must follow PEP 8 and must be documented thoroughly. Additionaly, you might want to check out PEP 257 describing docstring conventions. A good way to check your code quality are flake8 and pylint tools.

Use Sphinx syntax for documentation so that we can generate it automatically.

Reporting and Fixing Bugs

Any bugs concerning esrfconcert should be reported as an issue on the GitLab issue tracker.

Bug fixes and new features must be in a merge request form. Merge request commits should consist of single logical changes and bear a clear message respecting common commit message conventions. Before the change is merged it must be rebased against master.

Bug fixes must come with a unit test that will fail on the bug and pass with the fix. If an issue exists reference it in the branch name and commit message, e.g. fix-92-remove-foo and "Fix #92: Remove foo".