From 64f688d140c666723303a3753d06b48568f5bf4a Mon Sep 17 00:00:00 2001 From: Tanushree Tunstall Date: Fri, 1 Dec 2023 12:52:13 +0000 Subject: [PATCH] updated docs --- doc/contribute.rst | 14 ++++++++++---- 1 file changed, 10 insertions(+), 4 deletions(-) diff --git a/doc/contribute.rst b/doc/contribute.rst index 6f9fd3b..fc1cb4f 100644 --- 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 \ No newline at end of file +.. _resource validation: https://github.com/EATRIS/motbx/actions/workflows/validate_resources.yml