From d38ed40adfb995e9aa597fc5744a1212e7f35094 Mon Sep 17 00:00:00 2001 From: Johan Nyman Date: Mon, 23 Sep 2024 11:04:06 +0200 Subject: [PATCH] Contribution Guidelines: Require contributions to target in-dev (#1260) --- CONTRIBUTING.md | 3 ++- .../docs/for-developers/contribution-guidelines.md | 6 ++++-- 2 files changed, 6 insertions(+), 3 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index beced98156..b609a43658 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -9,4 +9,5 @@ This repository uses the following branches: * **_master_** is our main branch. We consider it stable and it is used in production. * The **_releaseXX_** branches are our in-development branches. When a release is ready, we decide to “freeze” that branch and create a new **_releaseXX+1_** branch. -We encourage you to base your contributions on the latest **_releaseXX_** branch, alternatively the **_master_** branch or a recently frozen **_releaseXX_** branch. The [_Sofie Releases_](https://nrkno.github.io/sofie-core/releases) page collects the status and timeline of the releases. +We require contributions to be based based on the latest **_release\*_** branch. +The [_Sofie Releases_](https://nrkno.github.io/sofie-core/releases) page collects the status and timeline of the releases. diff --git a/packages/documentation/docs/for-developers/contribution-guidelines.md b/packages/documentation/docs/for-developers/contribution-guidelines.md index 4e6ffadc97..f97118ca00 100644 --- a/packages/documentation/docs/for-developers/contribution-guidelines.md +++ b/packages/documentation/docs/for-developers/contribution-guidelines.md @@ -7,6 +7,8 @@ sidebar_position: 2 # Contribution Guidelines +_Last updated september 2024_ + ## About the Sofie TV Studio Automation Project The Sofie project includes a number of open source applications and libraries developed and maintained by the Norwegian public service broadcaster, [NRK](https://www.nrk.no/about/). Sofie has been used to produce live shows at NRK since September 2018. @@ -35,8 +37,8 @@ However, Sofie is a big project with many differing users and use cases. **Large 3. (If needed) NRK establishes contact with the RFC author, who will be invited to a workshop where the RFC is discussed. Meeting notes are published publicly on the RFC thread. 4. The contributor references the RFC when a pull request is ready. -### Base contributions on the in-development branch (or the master branch) -In order to facilitate merging, we ask that contributions are based on the latest (at the time of the pull request) _in-development_ branch (often named `release*`), alternatively the stable (eg. `master`) branch. NRK will take responsibility for rebasing stable contributions to the latest in-development branch if needed. +### Base contributions on the in-development branch +In order to facilitate merging, we ask that contributions are based on the latest (at the time of the pull request) _in-development_ branch (often named `release*`). See **CONTRIBUTING.md** in each official repository for details on which branch to use as a base for contributions. ## Developer Guidelines