diff --git a/README.md b/README.md index 12854a7..471d569 100644 --- a/README.md +++ b/README.md @@ -20,9 +20,21 @@ pip install checkpoint-schedules The usage guide of *checkpoint_schedules* is available [here](https://nbviewer.org/github/firedrakeproject/checkpoint_schedules/blob/main/docs/notebooks/tutorial.ipynb). +## Contributing +We welcome contributions to *checkpoint_schedules*! +To contribute please consider the following steps: +1. Fork the repository. +2. Make your changes. +3. Make sure that the tests pass by running `pytest test` and `pytest --nbval-lax docs/notebooks/` +4. Add tests for your changes (if applicable). +5. Add documentation for your changes that follows the [Sphinx](https://sphinx-rtd-tutorial.readthedocs.io/en/latest/docstrings.html) format. +6. Submit your pull request. + +## Bug reports +Please report bugs on the [issue tracker](https://github.com/firedrakeproject/checkpoint_schedules/issues). + ## Documentation The complete documentation for checkpoint_schedules is available at [Firedrake project website](https://www.firedrakeproject.org/checkpoint_schedules/). - ## License *checkpoint_schedules* is licensed under the GNU LGPL version 3. See the LICENSE file for details. diff --git a/docs/source/index.rst b/docs/source/index.rst index b39724f..0fae71d 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -19,7 +19,7 @@ If you want to quickly get up and running with *checkpoint_schedules* your adjoi $ pip install checkpoint-schedules * Familiarise with *checkpoint_schedules* by acessing the :ref:`introduction `. -* Go through to an `illustrative example `__ that explains the usage of *checkpoint_schedules* for step-based incremental checkpointing of the adjoints. +* Go through to an `illustrative example `_ that explains the usage of *checkpoint_schedules* for step-based incremental checkpointing of the adjoints. API documentation ================= @@ -28,4 +28,23 @@ The complete list of all the classes and methods in *checkpoint_schedules* is av `. +Contributing +============ +We welcome contributions to *checkpoint_schedules*! +To contribute please consider the following steps: +1. Fork the repository. + +2. Make your changes. + +3. Make sure that the tests pass by running `pytest test` and `pytest --nbval-lax docs/notebooks/`. + +4. Add tests for your changes (if applicable). + +5. Add documentation for your changes that follows the `Sphinx `_ format. + +6. Submit a pull request. + +Bug reports +=========== +Please report bugs on the `issue tracker `_.