Skip to content

Latest commit

 

History

History
62 lines (41 loc) · 1.77 KB

CONTRIBUTING.md

File metadata and controls

62 lines (41 loc) · 1.77 KB

Contributing

Code Formatting

This app is utilizing the Black code style. Every commit has to adhere to it.

This repository uses pre-commit to verify compliance with formatting rules. To use:

  1. Install pre-commit.
  2. From inside the aa-srp root directory, run pre-commit install.
  3. You're all done! Code will be checked automatically using git hooks.

You can check if your code to commit adheres to the given style by simply running:

pre-commit

or to check all files:

pre-commit run --all-files

The following will be checked by pre-commit:

  • no trailing whitespaces (excluded are: minified js and css, .po and .mo files)
  • one, and only one, empty line at the end of every file (excluded are: minified js and css, .po and .mo files)
  • line ending is LF
  • code formatted according to black code style
  • code conforms with flake8

Contributing via pull requests

To contribute code via pull request, make sure that you fork the repository and branch your changes from the development branch. Only pull requests towards the development branch will be considered.

Please make sure you have signed the License Agreement by logging in at https://developers.eveonline.com before submitting any pull requests.

Test Coverage

Please make sure your contribution comes with tests covering your additions and changes. We aim to always improve the test coverage in this project. Pull requests lowering the test coverage will not be considered for merging.

You can run tests locally via:

make coverage

The full tox-test suite can be run via:

tox