Release cycle document

[tarepan]

🐛 Bug

Current document describe Pull Request process as GitHub flow (master + feature branch).
But current PR template mention about release branch, and feature PR should be merged toward release branch.
There is document-template mismatch.

To Reproduce

"doc - Contributing" explain master-based feature branch (GitHub flow).

git checkout my-PR-branch
git rebase master

"PR template" explain as below.

We separated bug-fix PRs and feature PRs and they shall land in master and release/1.X-dev accordingly.

There is disparity between doc and PR template.

Expected behavior

Doc and PR template match its contents.

As contributor, I hope clear explanation of below information.

• branch model (e.g. GitHub flow)
• master-release relationship (e.g. daily master->release merge)
• refactoring PR (which branch it should based on?)

Environment

master 4d9db86

[Borda]

I see your confusion and we shall clean it...

• in past (fro 1.0.x releases we had model all in master and bug cherry-picking in separate release branch)
• now (since 1.1.0) we have master only for bugfixes and all features/refactoring goes to the release branch which will be later merged bask to master

[tarepan]

Clear explanation, thanks!

In this branch model, once a release branch is created, the release branch cannot contain bugFix in master until actual release.
Is it right?

[Borda]

In this branch model, once a release branch is created, the release branch cannot contain bugFix in master until actual release.
Is it right?

well not exactly and we are still in process of fine-tuning this process... apriori the feature branch atm release/1.2-dev is the target for all feature/refactoring-like PRs (and master is the target for baby bugfix-like PRs), but we do not want to get to fair from fixes (and also from perspective of future merging back to master and reducing then eventual collisions to a minimum) we are doing sync after every bugfix release as you can see #5253 #5383

[tchaton]

Hey @tarepan,

Would you mind to create a PR to update "doc - Contributing" with @Jirka clarifications ?

Best,
T.C

[tarepan]

Hi @tchaton,

I am a bewbie in PyTorch-Lightning contribution, so have no confidence about whole contribution workflow.
If can, core contributors will be best for creating the PR.

Sincerely,
Tarepan