From 2316ec4addb2389f8b691aede4b9f6ace87b6baf Mon Sep 17 00:00:00 2001 From: Adam Honse Date: Sun, 24 Mar 2024 18:59:10 -0500 Subject: [PATCH] Add notes discouraging merge requests with protected master branch as the source --- .gitlab/merge_request_templates/New Device.md | 1 + CONTRIBUTING.md | 1 + 2 files changed, 2 insertions(+) diff --git a/.gitlab/merge_request_templates/New Device.md b/.gitlab/merge_request_templates/New Device.md index 9740c96c..ba552ea5 100644 --- a/.gitlab/merge_request_templates/New Device.md +++ b/.gitlab/merge_request_templates/New Device.md @@ -10,6 +10,7 @@ Please put "Initial commit for" name of the product, including manufacturer abov # Checklist for Accepting a Merge Request for a New Device +- [ ] The source branch of the merge request is not protected (`master` is protected by default when creating a fork, so it is recommended to not use it as your source). - [ ] The `New Device` issue raised for this device is linked to this MR with a keyword `Closes / Resolves / Implements` - [ ] There is a device protocol page in the [Developer Wiki](https://gitlab.com/OpenRGBDevelopers/OpenRGB-Wiki) or there is enough information / captures in the `New Device` issue to provide ongoing support. - [ ] The code to be merged follows the style guide and change requirements as [documented in the contributing guide](https://gitlab.com/CalcProgrammer1/OpenRGB/-/blob/master/CONTRIBUTING.md). diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 15dd819b..bbdd985c 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -11,6 +11,7 @@ To create a merge request, log into GitLab and fork the OpenRGB project. Push y * Mark your merge request as a draft (start title with "Draft:") until it has been tested and verified working. * Follow the Style Guidelines below when making your code changes. * Avoid using `git merge` when updating your fork. The OpenRGB project uses a linear git history, meaning all changes are rebased onto the tip of master. By using `git rebase` to update your fork, you will make it easier to accept merge requests. +* Do not submit a merge request using your fork's `master` branch as the source. The `master` branch is protected by default when creating a fork and I cannot manually rebase a protected branch before merging. If you submit a merge request with a protected `master` branch as the source, it may not get merged until you unprotect it. ### Pipelines, Shared Runners and Quotas