diff --git a/docs/source/devguide/index.rst b/docs/source/devguide/index.rst index 7484c807b..b82e304ac 100644 --- a/docs/source/devguide/index.rst +++ b/docs/source/devguide/index.rst @@ -24,24 +24,54 @@ And/or contribute to the source code by: Contributing to the code ------------------------ +For complete information on contributions with GitHub see this guide on `GitHub `_. + .. tip:: If you're a beginner, look for `issues tagged with "Good first issue" `_. These issues are usually relatively easy to tackle and perfect for newcomers. -1) `Fork the repository `_ +#. `Fork the repository `_ + + By forking the repository, you create a copy where you can safely make changes. + +#. Clone your fork + + .. code-block:: bash -By forking the repository, you create a copy where you can safely make changes. + git clone https://github.com/[your_username]/FESTIM -2) Make your changes -3) `Open a PR `_ -4) Wait for a :ref:`maintainer` to review your PR + Remember to replace ``[your_username]`` with your GitHub username. + +#. Make your changes + + Commit your changes locally and push them to your fork. + + .. code-block:: bash -Before merging your changes, they have to be reviewed. We ensure the changes don't break anything during the review and eventually propose/request improvements. -The time before the review will depend on the maintainers' availability. + git add [modified files] + git commit -m "Your commit message" + git push -5) When everything is in order, the maintainers will merge your PR! +#. Optional: Test your code + + If you are adding new features or fixing bugs, it is important to test your code. + See :ref:`Test suite` for more information. + +#. Optional: Build the documentation + + You may want to build the documentation to see if your changes are correctly reflected or if you are updating the docs. + See :ref:`Documentation guide` for more information. + +#. `Open a PR `_ + +#. Wait for a :ref:`maintainer` to review your PR + + Before merging your changes, they have to be reviewed. We ensure the changes don't break anything during the review and eventually propose/request improvements. + The time before the review will depend on the maintainers' availability. + +#. When everything is in order, the maintainers will merge your PR! ----------- Maintainers @@ -69,6 +99,8 @@ Click `here `_ at the root of the FESTIM repository. +You need to have the right dependencies installed to test your code (see :ref:`installation`). + .. note:: Make sure to install ``pytest`` to run the test suite locally: