Contributing¶

Contributions are welcome, and they are greatly appreciated! Every little bit helps, and credit will always be given.

Bug reports/Feature Requests/Feedback/Questions¶

It is incredibly helpful to us when users report bugs, unexpected behaviour, or request features. You can do the following:

Report a bug <https://github.com/steven-murray/21cmSense/issues/new?template=bug_report.md>

Request a Feature <https://github.com/steven-murray/21cmSense/issues/new?template=feature_request.md>

Ask a Question <https://github.com/steven-murray/21cmSense/issues/new?template=question.md>

When doing any of these, please try to be as succinct, but detailed, as possible, and use a “Minimum Working Example” whenever applicable.

Documentation improvements¶

21cmSense could always use more documentation, whether as part of the official 21cmSense docs, in docstrings, or even on the web in blog posts, articles, and such.

Development¶

Note that it is highly recommended to work in an isolated python environment with all development requirements installed. This will also ensure that pre-commit hooks will run that enforce the black coding style. If you do not install these requirements, you must manually run black before committing your changes, otherwise your changes will likely fail continuous integration.

First fork 21cmSense (look for the “Fork” button), then clone the fork locally:
```
git clone git@github.com:your_name_here/21cmSense.git
```

Create a branch for local development:

git checkout -b name-of-your-bugfix-or-feature

When you’re done making changes, run all the checks, doc builder and spell checker with tox one command:
```
tox
```

Commit your changes and push your branch to GitHub:

git add .
git commit -m "Your detailed description of your changes."
git push origin name-of-your-bugfix-or-feature

Submit a pull request through the GitHub website.

Pull Request Guidelines¶

If you need some code review or feedback while you’re developing the code just make the pull request. You can mark the PR as a draft until you are happy for it to be merged.

Tips¶

To run a subset of tests:

tox -e envname -- py.test -k test_myfeature

To run all the test environments in parallel (you need to pip install detox):

detox