Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

guidelines for how to contribute and report a bug #47

Merged
merged 5 commits into from
Oct 6, 2023
Merged

guidelines for how to contribute and report a bug #47

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
72f2b0b
guidelines for how to contribute
Ig-dolci Oct 4, 2023
ea769bb
Update index.rst
Ig-dolci Oct 4, 2023
ac12b56
contribunting steps
Ig-dolci Oct 5, 2023
2a22383
minors
Ig-dolci Oct 5, 2023
57dbbde
fixing the url link
Ig-dolci Oct 6, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 13 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
21 changes: 20 additions & 1 deletion docs/source/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 <introduction>`.
* Go through to an `illustrative example <https://nbviewer.org/github/firedrakeproject/checkpoint_schedules/blob/main/docs/notebooks/tutorial.ipynb>`__ that explains the usage of *checkpoint_schedules* for step-based incremental checkpointing of the adjoints.
* Go through to an `illustrative example <https://nbviewer.org/github/firedrakeproject/checkpoint_schedules/blob/main/docs/notebooks/tutorial.ipynb>`_ that explains the usage of *checkpoint_schedules* for step-based incremental checkpointing of the adjoints.

API documentation
=================
Expand All @@ -28,4 +28,23 @@ The complete list of all the classes and methods in *checkpoint_schedules* is av
<checkpoint_schedules-api-reference>`.


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 a pull request.

Bug reports
===========
Please report bugs on the `issue tracker <https://github.com/firedrakeproject/checkpoint_schedules/issues>`_.
Loading