From 72f2b0bc2736fac2d6a5e7743255fd98270c6471 Mon Sep 17 00:00:00 2001 From: Iglesia Dolci Date: Wed, 4 Oct 2023 13:41:38 +0100 Subject: [PATCH 1/5] guidelines for how to contribute --- README.md | 11 ++++++++++- docs/source/index.rst | 16 ++++++++++++++++ 2 files changed, 26 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 12854a7..34bc6bc 100644 --- a/README.md +++ b/README.md @@ -20,9 +20,18 @@ 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. Submit a 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..2a66c6e 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -28,4 +28,20 @@ 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. Submit a pull request. + +Bug reports +=========== +Please report bugs on the [issue tracker](https://github.com/firedrakeproject/checkpoint_schedules/issues). + + + + + From ea769bbd17e8e4b9f0d150eb92865055f720d3f6 Mon Sep 17 00:00:00 2001 From: Daiane Iglesia Dolci <63597005+Ig-dolci@users.noreply.github.com> Date: Wed, 4 Oct 2023 13:46:52 +0100 Subject: [PATCH 2/5] Update index.rst --- docs/source/index.rst | 6 ------ 1 file changed, 6 deletions(-) diff --git a/docs/source/index.rst b/docs/source/index.rst index 2a66c6e..071f432 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -39,9 +39,3 @@ To contribute please consider the following steps: Bug reports =========== Please report bugs on the [issue tracker](https://github.com/firedrakeproject/checkpoint_schedules/issues). - - - - - - From ac12b562d43fb1bb5921620082c632c3e1764d66 Mon Sep 17 00:00:00 2001 From: Iglesia Dolci Date: Thu, 5 Oct 2023 13:37:13 +0100 Subject: [PATCH 3/5] contribunting steps --- README.md | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 34bc6bc..a94d2c1 100644 --- a/README.md +++ b/README.md @@ -25,7 +25,10 @@ We welcome contributions to *checkpoint_schedules*! To contribute please consider the following steps: 1. Fork the repository. 2. Make your changes. -3. Submit a pull request. +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). From 2a22383a7db4689ee27bc945c3ce2fded1073c34 Mon Sep 17 00:00:00 2001 From: Daiane Iglesia Dolci <63597005+Ig-dolci@users.noreply.github.com> Date: Thu, 5 Oct 2023 13:38:42 +0100 Subject: [PATCH 4/5] minors --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index a94d2c1..471d569 100644 --- a/README.md +++ b/README.md @@ -28,7 +28,7 @@ To contribute please consider the following steps: 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. +6. Submit your pull request. ## Bug reports Please report bugs on the [issue tracker](https://github.com/firedrakeproject/checkpoint_schedules/issues). From 57dbbde7160fef13e8db1fd7e032c37f65687301 Mon Sep 17 00:00:00 2001 From: Iglesia Dolci Date: Fri, 6 Oct 2023 07:40:23 +0100 Subject: [PATCH 5/5] fixing the url link --- docs/source/index.rst | 15 ++++++++++++--- 1 file changed, 12 insertions(+), 3 deletions(-) diff --git a/docs/source/index.rst b/docs/source/index.rst index 071f432..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 ================= @@ -32,10 +32,19 @@ Contributing ============ We welcome contributions to *checkpoint_schedules*! To contribute please consider the following steps: + 1. Fork the repository. + 2. Make your changes. -3. Submit a pull request. + +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](https://github.com/firedrakeproject/checkpoint_schedules/issues). +Please report bugs on the `issue tracker `_.