Welcome, friend! Open-source software isn't open open-source without the community. We appreciate your interest and welcome all contributions. To help keep everything moving smoothly, we have a few guidelines.
If you think you've found a bug, let us know here. We'll do our best to deal with it ASAP, but please be patient as we also work many other projects!
If you think you can fix one of the bugs, or would like to submit a new feature, then let's get coding!
Once you've cloned the repository, fork it, and get your development environment set up. We use conda, nox, and pre-commit to handle testing and linting. Between them, they make sure that all checks run in isolated environments. Please make sure you activate them before making any changes, using the commands below:
conda env create -f environments/devel.yml
conda activate bic086
pre-commit install --install-hooks
pre-commit install --hook-type pre-pushNow, you don't even have to think about linting or testing. When you commit a change, pre-commit will automatically run black, isort, mypy, and a suite of flake8-based linters. When you push a change, nox will run a more robust, but slightly slower, series of lints, including security checks, testing with pytest, and automatic doc building with sphinx.
Speaking of documentation and testing - if you add new code, please add documentation and tests for it as well. We use napoleon numpy doc strings. Include the docstring with the code, and sphinx will handle everything else! Once your happy with your code, open a pull-request, and we will reveiw ASAP.
If you haven't heard of it already, give a peek to to gh, GitHub's official CLI. It allows to manage all of the above steps from the command-line, from forking, to raising issues, and checking on the status of your pull request. Not a necessity, but for you terminal warriors out there, it just might help!