Merge pull request #212 from TUMFARSynchrony/jg-update-contributing

Update pull request guidelines

.github/pull_request_template.md

@@ -1,7 +1,18 @@
-This is a draft Pull Request Template.
+This is a draft Pull Request Template. Please fill out the neccessary details below
 
-- [ ] Description of what changes have been made (why and how for big features)
-- [ ] Reference [Issue](https://github.com/TUMFARSynchrony/experimental-hub/issues) sovled (if any)
-- [ ] Unit tests + have you tried merging from main?
-- [ ] Terminology consistent with the rest of the codebase?
-- [ ] Who do you think should review?
+# Overview
+TODO: What does this PR contain? Why was the change necessary?
+
+## Changes
+TODO: What was changed? How was the issue solved/feature implemented?
+
+## How to test?
+TODO: How can reviewers test the PR?
+
+# Checklist
+- [ ] Correct base branch was selected (usually `development`)
+- [ ] `development` was merged into this branch and potential conflicts resolved
+- [ ] [Issues](https://github.com/TUMFARSynchrony/experimental-hub/issues) which were solved are linked. Be sure to make that manually because Closes/Fixes keywords only work when base branch is main.
+- [ ] Terminology is consistent with the rest of the codebase
+- [ ] Reviewers are assigned
+- [ ] Optional: Wiki pages were updated to reflect the changes (list changed pages above)

.github/workflows/backend-static-code-analysis.yml

@@ -4,9 +4,11 @@ on:
   push:
     branches:
       - main
+      - development
   pull_request:
     branches:
       - main
+      - development
 
 jobs:
   static-code-analysis:

.github/workflows/frontend-workflow.yml

@@ -7,9 +7,10 @@ on:
   push:
     branches:
       - "main"
+      - "development"
     paths: "frontend/**"
   pull_request:
-    branches: ["main"]
+    branches: ["main", "development"]
 jobs:
   build:
     runs-on: ubuntu-latest

CONTRIBUTING.md

@@ -7,19 +7,23 @@ To contribute code to this project, see the following steps:
 0. Checkout our current open [Issues](https://github.com/TUMFARSynchrony/experimental-hub/issues) and add your contribution idea to our [discussion board](https://github.com/TUMFARSynchrony/experimental-hub/discussions/categories/ideas).
 1. Create a new branch in which changes are made. Branches should be named using the following convention: `[<frontend/backend>-]<initials>-<topic>`.  
    Branch names are in lowercase. If the change regards the frontend or backend start the name with `frontend` or `backend` respectively. If it's a general change this part is omitted. The topic can be multiple words which should be sperated by hyphens (`-`).
-2. Make sure your code works with the latest version of `main`, then create a pull request.
+2. Make sure your code works with the latest version of `development` (i.e. merge `development` into your branch and fix conflicts), then create a pull request.
+   - Choose `development` as base branch. If your branch is based on another branch, choose the other branch as base. Once the other branch is merged, your PR will automatically change its base to `development`. 
+   - Name the PR using a short and descriptive name
+   - Fill out the neccessary details in the pull request template
    - Assign the person who will perform the merge as _Assignee_ (usually yourself).
    - Assign specific people who should review the code as _Reviewers_. If you don't know who to assign, put NCEghtebas there as a default. At least one approval is required for the merge.
 3. (External) An appropriate reviewer will be assigned and review the code contribution like with the steps below.
    (Internal) Person reviewing replies on Discord that they will take the request and:
    1. Add themselves as _Reviewer_ (if not already)
-   1. Try running the code
-   1. Review the code (errors, style, comments, etc.)
+   2. Try running the code
+   3. Review the code (errors, style, comments, etc.)
 4. If
    - **Major changes** are needed then repeat the process after addressing changes which were requested by the reviewer.
    - **Minor changes** are needed then the reviewer can approve the request and let the code contributor know that they are free to merge after addressing the minor changes.
-5. Delete branch(es) after merging into `main`
+5. Delete branch(es) after merging
 
+Once `development` contains a stable, working version, it can be merged into `main` using a PR. This ensures that `main` is always stable.
 ## Conventions
 
 The following conventions should be followed when working on experimental-hub.