From 90266acd10783cc32df5dd9a9101b68e67a34df0 Mon Sep 17 00:00:00 2001 From: morpheus65535 Date: Tue, 23 Feb 2021 16:13:01 -0500 Subject: [PATCH] Update CONTRIBUTING.md --- CONTRIBUTING.md | 20 ++++++++++---------- 1 file changed, 10 insertions(+), 10 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index a2f42c596..f169d90df 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -8,14 +8,14 @@ ## Branching ## ### Basic rules ### -- master branch contains only stable releases (which have been merged to master) and is intended for end-users. -- develop branch is the target for integration and is not intended for end-users. -- `feature` is a temporary feature branch based on develop. +- `master` contains only stable releases (which have been merged to `master`) and is intended for end-users. +- `develop` is the target for integration and is not intended for end-users. +- `feature` is a temporary feature branch based on `develop`. ### Conditions ### -- master is not merged back to develop. -- develop is not re-based on master. -- all feature branches branch from develop only. +- `master` is not merged back to `develop`. +- `develop` is not re-based on `master`. +- all `feature` branches branch from `develop` only. - Bugfixes created specifically for a feature branch are done there (because they are specific, they're not cherry-picked to develop). - We will not release a patch (0.0.x) if a newer minor (0.x.0) has already been released. @@ -23,13 +23,13 @@ ## Typical contribution workflow ## ### Community devs ### - Fork the repository or pull latest changes if you already have forked it. -- Checkout development branch. +- Checkout `development` branch. - Make the desired changes. -- Submit a PR to Bazarr development branch. +- Submit a PR to Bazarr `development` branch. - Once reviewed, your PR will be merged using Squash and Merge with a meaningful message. ### Official devs team ### - All commits must have a meaningful commit message (ex.: Fixed issue with this, Improved process abc, Added input field to UI, etc.). -- Fixes can be made directly to development branch but keep in mind that a pre-release with a beta versioning will be created for every push you make. -- Features must be developed in dedicated feature branch and merged back to development branch using PR. +- Fixes can be made directly to `development` branch but keep in mind that a pre-release with a beta versioning will be created for every push you make. +- Features must be developed in dedicated feature branch and merged back to `development` branch using PR. - Once reviewed, your PR will be merged using Squash and Merge with a meaningful message.