Merge pull request #34 from EATRIS/docsupdate

updated docs
EATRIS · Dec 1, 2023 · 89d11b6 · 89d11b6
2 parents 1d5fa50 + 64f688d
commit 89d11b6
Showing 1 changed file with 10 additions and 4 deletions.
diff --git a/doc/contribute.rst b/doc/contribute.rst
@@ -17,9 +17,15 @@ want to actively contribute to it.
 Information for developers
 --------------------------
 
-When making changes to this repository, we follow the `GitHub flow`_. For each issue,
-a new branch is created, files are edited, and a pull request is created. When checks are passed,
-the pull request can be merged into the `main` branch.
+When making changes to this repository, we follow the `GitHub flow`_. For each issue:
+* Create a new branch
+* Edit the file(s)
+* Create a pull request (PR)
+  * automatically triggers validation checks
+* Merge PR into `main` branch after review
+* Delete the branch after merging PR
+* Review issue and mention PR in a comment
+* Close issue
 
 Issue templates
 ~~~~~~~~~~~~~~~
@@ -191,4 +197,4 @@ and changes made compared to a previous summary are made.
 .. _GitHub flow: https://docs.github.com/en/get-started/quickstart/github-flow
 .. _.github/ISSUE_TEMPLATE: https://github.com/EATRIS/motbx/tree/main/.github/ISSUE_TEMPLATE
 .. _.github/workflows: https://github.com/EATRIS/motbx/tree/main/.github/workflows
-.. _resource validation: https://github.com/EATRIS/motbx/actions/workflows/validate_resources.yml
+.. _resource validation: https://github.com/EATRIS/motbx/actions/workflows/validate_resources.yml