summaryrefslogtreecommitdiffhomepage
path: root/CONTRIBUTING.md
diff options
context:
space:
mode:
authormorpheus65535 <[email protected]>2021-12-31 18:01:34 -0500
committermorpheus65535 <[email protected]>2021-12-31 18:01:34 -0500
commitf56e07b1f4307cd837b17e1099261cd0f7c188d6 (patch)
treecf62049b91fe387f8be24831e9fb9f719f3e4b52 /CONTRIBUTING.md
parentd373bc8c0e936e8fecaf54cf2e122b0a0cfeca9f (diff)
downloadbazarr-f56e07b1f4307cd837b17e1099261cd0f7c188d6.tar.gz
bazarr-f56e07b1f4307cd837b17e1099261cd0f7c188d6.zip
no log: improved contributing.md
Diffstat (limited to 'CONTRIBUTING.md')
-rw-r--r--CONTRIBUTING.md16
1 files changed, 8 insertions, 8 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index b73710a1f..d037e905c 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -2,8 +2,8 @@
## Tools required
-- Python 3.7.x or 3.8.x (3.8.x is highly recommended and 3.9 is proscribed).
-- Pycharm or Visual Studio code IDE are recommanded but if you're happy with VIM, enjoy it!
+- Python 3.7.x to 3.10.x (3.9.x is highly recommended and 3.11 or greater is proscribed).
+- Pycharm or Visual Studio code IDE are recommended but if you're happy with VIM, enjoy it!
- Git.
- UI testing must be done using Chrome latest version.
@@ -16,30 +16,30 @@ As we're using Git in the development process, you better disable automatic upda
### Basic rules
- `master` contains only stable releases (which have been merged to `master`) and is intended for end-users.
-- `development` is the target for integration and is not intended for end-users.
+- `development` is the target for testing (around 10% of users) and is not intended for end-users looking for stability.
- `feature` is a temporary feature branch based on `development`.
### Conditions
- `master` is not merged back to `development`.
- `development` is not re-based on `master`.
-- all `feature` branches branch from `development` only.
+- all `feature` branches are branched from `development` only.
- Bugfixes created specifically for a feature branch are done there (because they are specific, they're not cherry-picked to `development`).
-- 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 (1.0.x) if a newer minor (1.x.0) has already been released. We only go forward.
## Typical contribution workflow
### Community devs
-- Fork the repository or pull latest changes if you already have forked it.
+- Fork the repository or pull the latest changes if you already have forked it.
- Checkout `development` branch.
- Make the desired changes.
- 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 commit message matching our standards.
### 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.
+- Fixes can be made directly to `development` branch but keep in mind that a pre-release with a beta versioning will be created every day a new push is made.
- 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.