CONTRIBUTING.md

Contributing to KerrGeoPy

Contributions are welcome and greatly appreciated! There are many different ways to contribute including writing tutorials, improving the documentation, submitting bug reports and suggesting or implementing new features.

Types of Contributions

Bug Reports and Feature Requests

If you identify a bug or have an idea for a new feature, open an issue at https://github.com/BlackHolePerturbationToolkit/KerrGeoPy/issues. For bug reports, please also include your operating system/processor architecture and any relevant information about your python environment.

Documentation

Improvements to the documentation are always welcome. Documentation for KerrGeoPy is generated from python docstrings using Sphinx and hosted on ReadTheDocs. Docstrings should follow the numpydoc format. The tutorial pages are generated from the Jupyter notebooks in https://github.com/BlackHolePerturbationToolkit/KerrGeoPy/tree/main/docs/source/notebooks using MyST-NB.

Contributing Code

To contribute code, follow the steps below to submit a pull request. See https://bhptoolkit.org/conventions.html for a list of naming conventions used throughout the package. Ideally, any new features should also come with unit tests and documentation. See https://github.com/BlackHolePerturbationToolkit/KerrGeoPy/tree/main/tests for more information about testing.

Getting Started

First, fork/clone the repository and create a new branch. After implementing changes, verify that all unit tests pass.

python -m unittest

To preview any changes to the documentation, build the docs

cd docs
make html

Finally, push the changes and submit a pull request through Github.

Community

KerrGeoPy is a part of the Black Hole Perturbation Toolkit. See the Users and Contributors page for more information.