docs: mention code formatting in the contribution section (#3431)

bayraktar1 · johanneskoester · web-flow · commit e8682b7b5294 · 2025-03-14T14:28:34.000+01:00
&lt;!--Add a description of your PR here--&gt;
Specify usage of Snakefmt and black in the contribution guide section of
the documentation.


### QC
&lt;!-- Make sure that you can tick the boxes below. --&gt;

* [ ] The PR contains a test case for the changes or the changes are
already covered by an existing test case.
* [x] The documentation (`docs/`) is updated to reflect the changes or
this is not necessary (e.g. if the change does neither modify the
language nor the behavior or functionalities of Snakemake).


&lt;!-- This is an auto-generated comment: release notes by coderabbit.ai
--&gt;
## Summary by CodeRabbit

- **Documentation**
  - Revised the contribution guidelines to enhance clarity.
- Introduced a new step requiring standardized code formatting before
commits.
  - Renumbered subsequent steps to reflect the updated process.
&lt;!-- end of auto-generated comment: release notes by coderabbit.ai --&gt;

Co-authored-by: Johannes Köster &lt;johannes.koester@tu-dortmund.de&gt;
diff --git a/docs/project_info/contributing.rst b/docs/project_info/contributing.rst
@@ -75,11 +75,12 @@ To create a Pull Request you need to do these steps:
 4. Go to the created snakemake folder with :code:`cd snakemake`.
 5. Create a new branch with :code:`git checkout -b <descriptive_branch_name>`.
 6. Make your changes to the code or documentation.
-7. Run :code:`git add .` to add all the changed files to the commit (to see what files will be added you can run :code:`git add . --dry-run`).
-8. To commit the added files use :code:`git commit`. (This will open a command line editor to write a commit message. These should have a descriptive 80 line header, followed by an empty line, and then a description of what you did and why. To use your command line text editor of choice use (for example) :code:`export GIT_EDITOR=vim` before running :code:`git commit`).
-9. Now you can push your changes to your Github copy of Snakemake by running :code:`git push origin <descriptive_branch_name>`.
-10. If you now go to the webpage for your Github copy of Snakemake you should see a link in the sidebar called "Create Pull Request".
-11. Now you need to choose your PR from the menu and click the "Create pull request" button. Be sure to change the pull request target branch to <descriptive_branch_name>!
+7. Format your changes with `Snakefmt <https://github.com/snakemake/snakefmt>`_ or `BLACK <https://github.com/psf/black>`_.
+8. Run :code:`git add .` to add all the changed files to the commit (to see what files will be added you can run :code:`git add . --dry-run`).
+9. To commit the added files use :code:`git commit`. (This will open a command line editor to write a commit message. These should have a descriptive 80 line header, followed by an empty line, and then a description of what you did and why. To use your command line text editor of choice use (for example) :code:`export GIT_EDITOR=vim` before running :code:`git commit`).
+10. Now you can push your changes to your Github copy of Snakemake by running :code:`git push origin <descriptive_branch_name>`.
+11. If you now go to the webpage for your Github copy of Snakemake you should see a link in the sidebar called "Create Pull Request".
+12. Now you need to choose your PR from the menu and click the "Create pull request" button. Be sure to change the pull request target branch to <descriptive_branch_name>!
 
 If you want to create more pull requests, first run :code:`git checkout main` and then start at step 5. with a new branch name.
 
