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.

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

Explain branching/merging strategy in CONTRIBUTING.md #1200

Closed
kelson42 opened this issue Jun 15, 2019 · 1 comment · Fixed by #1209
Closed

Explain branching/merging strategy in CONTRIBUTING.md #1200

kelson42 opened this issue Jun 15, 2019 · 1 comment · Fixed by #1209
Assignees
Milestone

Comments

@kelson42
Copy link
Collaborator

Add a new paragraph "Branching" in CONTRIBUTING.md

Following questions should be answered

  • What are the "develop", "release" and "master" branches or any other branches?
  • How to merge a PR?
  • When to do rebase?
  • How releases are made? How to deal with many releases in parallel?
@macgills
Copy link
Contributor

I think I will make a PR onto master because the next time master is getting updated is for 3.0.
Brief template of my answers so we can discuss them here:
Develop is what we branch off of while working on new features, develop is the actively worked on next release of the app.
Release should be ignored, it is a temporary measure that will go away shortly (will not include this in the contrib section).
Master is a history of releases, once committed to from develop and tagged we create a release on the play store & GitHub releases.
All work should be done on feature branches either feature/* or <username>/feature/*.
If we need to release a fix or update to an existing version we create a hotfix/* branch off of master, commit back to master, tag and release, merge master to develop.
All PRs will be merge committed after they have passed all checks and have at least 1 reviewer approving.
Rebasing should essentially never happening, each branch should have distinct history so it should be avoided.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants