From 5722aaeefbd6d224686b658fcb2defc70e7a0c3d Mon Sep 17 00:00:00 2001 From: Francois Colleoni <110899888+inoelloc@users.noreply.github.com> Date: Wed, 17 Jul 2024 19:16:37 +0200 Subject: [PATCH] DOC: Update contributor guide summary (#270) - Update how to fork - Remove switching to maintenance branch - Add linters and formatters as command to run before submitting --- .../development_process_summary.rst | 19 +++++++++++++------ 1 file changed, 13 insertions(+), 6 deletions(-) diff --git a/doc/source/contributor_guide/development_process_summary.rst b/doc/source/contributor_guide/development_process_summary.rst index 66284ac0..61d39014 100644 --- a/doc/source/contributor_guide/development_process_summary.rst +++ b/doc/source/contributor_guide/development_process_summary.rst @@ -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 ----- @@ -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