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

Details for contribution workflow #865

Merged
merged 2 commits into from
Aug 5, 2024
Merged

Details for contribution workflow #865

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0dc33e0
added details
RemDelaporteMathurin Aug 2, 2024
80ff56d
added optional steps
RemDelaporteMathurin Aug 5, 2024
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
34 changes: 26 additions & 8 deletions docs/source/devguide/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,18 +30,36 @@ Contributing to the code

These issues are usually relatively easy to tackle and perfect for newcomers.

1) `Fork the repository <https://github.com/festim-dev/FESTIM/fork>`_
#. `Fork the repository <https://github.com/festim-dev/FESTIM/fork>`_

By forking the repository, you create a copy where you can safely make changes.
By forking the repository, you create a copy where you can safely make changes.

2) Make your changes
3) `Open a PR <https://github.com/festim-dev/FESTIM/compare>`_
4) Wait for a :ref:`maintainer<Maintainers>` to review your PR
#. Clone your fork

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.
.. code-block:: bash

git clone https://github.com/[your_username]/FESTIM

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

git add [modified files]
git commit -m "Your commit message"
git push

#. `Open a PR <https://github.com/festim-dev/FESTIM/compare>`_

#. Wait for a :ref:`maintainer<Maintainers>` 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.

5) When everything is in order, the maintainers will merge your PR!
#. When everything is in order, the maintainers will merge your PR!

-----------
Maintainers
Expand Down
Loading