search

choderalab / software-development

A primer on software development best practices for computational chemistry
255 stars 76 forks source link

Create VERSION_CONTROL.md #35

Closed bas-rustenburg closed 7 years ago

bas-rustenburg commented 7 years ago

Working on this now.

bas-rustenburg commented 7 years ago

By feature branches, do you mean Github flow? https://guides.github.com/introduction/flow/index.html

I assume we don't want to recommend the git-flow model, which is overkill for small projects.

jchodera commented 7 years ago

Thanks! The hope is to get people in the lab and other labs to do the same thing, not different things, to make it easier to collaborate. The overview of different systems is great, but we should open or close with a specific recommendation to use GitHub and either the fork merge model or the feature branch model. I think most of us have found the feature branch model works better, so maybe we should recommend that for core developers but link the fork merge model docs as a way external devs can contribute?

bas-rustenburg commented 7 years ago

Added recommendation to use github, and the branching model. Mentioned the fork model as an alternative for people that want to allow outside collaborators, or experimental development on a codebase.

Also mentioned the more professional git-flow model, while mentioning that it may be overkill for small projects.

jchodera commented 7 years ago

Looks great, thanks! Merge when ready!