mirror/bazarr
1
0
Fork 0
mirror of https://github.com/morpheus65535/bazarr synced 2024-12-23 08:13:14 +00:00
Code Issues Releases Wiki Activity

Update CONTRIBUTING.md

Browse source
This commit is contained in:
morpheus65535 2021-02-23 16:13:01 -05:00 committed by GitHub
parent a317caf022
commit 90266acd10
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 10 additions and 10 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

20
CONTRIBUTING.md
View file

@ -8,14 +8,14 @@
## Branching ## ## Branching ##
### Basic rules ### ### Basic rules ###
- master branch contains only stable releases (which have been merged to master) and is intended for end-users. - `master` 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. - `develop` is the target for integration and is not intended for end-users.
- `feature` is a temporary feature branch based on develop. - `feature` is a temporary feature branch based on `develop`.
### Conditions ### ### Conditions ###
- master is not merged back to develop. - `master` is not merged back to `develop`.
- develop is not re-based on master. - `develop` is not re-based on `master`.
- all feature branches branch from develop only. - 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). - 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. - 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 ## ## Typical contribution workflow ##
### Community devs ### ### Community devs ###
- Fork the repository or pull latest changes if you already have forked it. - Fork the repository or pull latest changes if you already have forked it.
- Checkout development branch. - Checkout `development` branch.
- Make the desired changes. - 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. - Once reviewed, your PR will be merged using Squash and Merge with a meaningful message.
### Official devs team ### ### 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.). - 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. - 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. - 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. - Once reviewed, your PR will be merged using Squash and Merge with a meaningful message.