search

TecKnow / muster-tools

A package for assigning players to tables at multi-table, walk-in gaming events.
GNU General Public License v3.0
0 stars 0 forks source link

Investigate possible release structures #19

Closed TecKnow closed 3 years ago

TecKnow commented 3 years ago

Soon it will be time to publish the package to NPM and tag the first alpha release. What are the best practices around doing this? Should the project develop on the main branch and simply tag releases, or should there be a branch specifically for releases?

Github does publish some best practices, which should be reviewed. If I recall correctly Atlassian also discusses the gitflow workflow in their well-known git tutorial so that should be checked as well.

I know that the npm package management tool supports installing from github and that npm packages can be tightly linked to github in general, I should also see if npm has any opinions.

TecKnow commented 3 years ago

It has been decided to use a gitflow style structure as described here: Gitflow Workflow | Atlassian Git Tutorial

Given the highly experimental nature of the project and the fast-changing nature of user needs in the problem domain, lots of branches and the need to quickly revert to a known good state are required, and the gitflow workflow may best balance those needs.