Skip to content

Commit

Permalink
Add pull requests flow to README (#32)
Browse files Browse the repository at this point in the history
* Add PR flow for protected branches.
  • Loading branch information
phnzb committed Oct 12, 2023
1 parent 7637218 commit f1c0282
Showing 1 changed file with 12 additions and 2 deletions.
14 changes: 12 additions & 2 deletions README.md
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)!

0 comments on commit f1c0282

Please sign in to comment.