shashwatak/satellite-js

Git workflow

Closed this issue · 5 comments

ezze commented

I propose all contributors to follow some Git workflow similar to Gitflow workflow. It will allow to keep master branch clean and use it for tagged releases only.

I already created a develop branch but not sure whether it should be set as base branch in repository settings. At the moment, master branch is a default (base) branch, and all pull requests proposed by other contributors are based to this branch by default. It doesn't fit the proposed workflow and each time contributor creates a pull request he/she should set a base branch of pull request to develop manually to follow this workflow. Changing default branch from master to develop in repository settings can make develop branch a default base branch for new pull requests but only @shashwatak is able to change this branch as repo's owner.

What do you think about this, guys?

ezze commented

Or we can use master branch as development branch (as is at the moment) and create a separate release branch for tagged releases. develop branch is not required in this case and there is no need for @shashwatak to change the default branch of repository.

Sounds good to me, as long as we add some clear instructions for workflow to the readme. Not everyone is familiar with it.

develop is now the default branch

ezze commented

@shashwatak, thanks a lot for participation! @davidcalhoun, @DangoDev, please rebase your pull requests to develop branch, guys.

ezze commented

Added Contributing section to README.md.