Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add pull requests flow to README #32

Merged
merged 4 commits into from
Oct 12, 2023
Merged

Add pull requests flow to README #32

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
5df4b99
Add PR flow for protected branches.
phnzb Oct 12, 2023
ecc435f
Fix typo
phnzb Oct 12, 2023
d58efeb
Merge branch 'develop' of github.com:nzbgetcom/nzbget into feature/re…
phnzb Oct 12, 2023
d7068a7
Add delete rule
phnzb Oct 12, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
14 changes: 12 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,11 +37,21 @@ Please follow [instructions](https://nzbget.com/documentation/building-developme

Branches naming policy

- `main` is a protected branch that constains only release code
- `develop` is a protected branch
- `main` is a protected branch that contains only release code
- `develop` is a protected branch for development
- new branches should follow the following convention:
- `hotfix/brief-description` for any small hotfixes
- `feature/brief-description` for any new developments
- `bugfix/brief-description` for bugs

Pull requests flow for `develop` and `main` branches:

1. For PRs targeting `develop` branch `Squash and merge` mode must be used.
2. After merging branch to `develop`, branch must be deleted.
3. For release PR (`develop` -> `main`) `Create a merge commit` mode must be used.
4. After merging `develop` -> `main`, must be back merge `main` -> `develop` before any changes in `develop` branch.

This flow results to the fact that in the PR to master branch we see only the squashed commits that correspond to the PRs in the develop branch in current release cycle.


We entice our users to participate in the project, please don't hesitate to get involved - create a [new issue](https://github.com/nzbgetcom/nzbget/issues/new) or [pull request](https://github.com/nzbgetcom/nzbget/compare)!