search

shashwatak / satellite-js

Modular set of functions for SGP4 and SDP4 propagation of TLEs.
MIT License
911 stars 145 forks source link

Git workflow #35

Closed ezze closed 6 years ago

ezze commented 6 years ago

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 6 years ago

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.

davidcalhoun commented 6 years ago

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

shashwatak commented 6 years ago

develop is now the default branch

ezze commented 6 years ago

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

ezze commented 6 years ago

Added Contributing section to README.md.