Skip to content

Latest commit

 

History

History
75 lines (54 loc) · 1.97 KB

CONTRIBUTING.md

File metadata and controls

75 lines (54 loc) · 1.97 KB
Raw

Contribution guidelines

Contributions to becquerel are welcome and encouraged, whether it is reporting bugs, requesting features, or contributing code. Please follow these guidelines when contributing to this project.

Developer Instructions

pip install -r requirements-dev.txt
python setup.py develop

pip install pre-commit
pre-commit install

(It is more convenient to use develop so that the code is soft-linked from the installation directory, and the installed package will always use the current version of code.)

Linting, formatting, and other checks

We use pre-commit to automatically run various checks and formatting tools in the CI. If pre-commit is installed, it will automatically run when committing new code, and it can also be run at any time using the following command:

pre-commit run --all

or run on any files not yet committed to the repository using

pre-commit run --files <filename1> <filename2> ...

Running the tests

(Requires requirements-dev.txt to be installed) To run the tests using pytest, from the root directory of the repo:

pytest

(python setup.py test is still supported also.) By default, a code coverage report is printed to the terminal. Tests marked webtest or plottest are by default skipped for the sake of speed. To run all tests, clear the pre-configured markers option:

pytest -m ""

To produce an HTML code coverage report in directory htmlcov with line-by-line highlighting:

pytest --cov-report html:htmlcov

Code Style Guide

Use google standards.

Checklist for code contributions

  • Branch off of main
  • Develop the feature or fix
  • Write tests to cover all use cases
  • Ensure all checks pass (pre-commit)
  • Ensure all tests pass (pytest)
  • Ensure test coverage is >95%
  • Push branch to GitHub and create a pull request to main