Skip to content

Commit

Permalink
DOC: Update contributor guide summary (#270)
Browse files Browse the repository at this point in the history
- Update how to fork
- Remove switching to maintenance branch
- Add linters and formatters as command to run before submitting
  • Loading branch information
inoelloc authored Jul 17, 2024
1 parent 31ee4be commit 5722aae
Showing 1 changed file with 13 additions and 6 deletions.
19 changes: 13 additions & 6 deletions doc/source/contributor_guide/development_process_summary.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ Development Process Summary
Fork
----

Go to https://github.com/DassHydro/smash/fork and create your own ``Fork`` of the project. Uncheck the box "Copy the main branch only".
Go to https://github.com/DassHydro/smash/fork and create your own ``Fork`` of the project.

Clone
-----
Expand Down Expand Up @@ -52,27 +52,34 @@ Activate the conda environment:
Develop contribution
--------------------

Switch to the latest development version of smash (``maintenance/x.y.z``):
Create a new branch, based on main, on which you will implement your development:

.. code-block:: none
(smash-dev) git checkout maintenance/x.y.z
(smash-dev) git checkout -b your-development-branch
Create a new branch on which you will implement your development:
Then, build in editable mode:

.. code-block:: none
(smash-dev) git checkout -b your-development-branch
(smash-dev) make edit
Submit
------

Before submitting your changes, make sure that the tests pass (although they will also be executed automatically once the submission has been made):
Before submitting your changes, make sure that the unit tests pass (although they will also be executed automatically once the submission has been made):

.. code-block:: none
(smash-dev) make test
As well as linters and formatters:

.. code-block:: none
(smash-dev) make check
(smash-dev) make format
If changes have also been made to the documentation, also run the command to check the compilation of the documentation:

.. code-block:: none
Expand Down

0 comments on commit 5722aae

Please # to comment.