search

LCfP / python_basic_track

This repository will be used to develop and publish the materials for the Python basic track offered by the LCfP. It is initially meant to be used together with the lab-sessions we provide.
0 stars 0 forks source link

Workflow #3

Open VincentVelthuizen opened 7 years ago

VincentVelthuizen commented 7 years ago

A note with regards to workflow. For now I would suggest doing the following:

We will have an issue for each chapter. We will have a milestone for a subset of chapters.

We will have a branch for writing each chapter. When a chapter is 'finished' from a writing perspective the branch is merged into 'dev' (maybe not a great name anymore).

When all chapters in a milestone are written the 'dev' branch is merged into 'check_writing' were @lukko @NHartsuiker and @szirbik can check it and suggest changes. The issue is kept for suggestions/questions per chapter.

When the checks are finished the issue can be closed.

When all the issues of a milestone are closed the new version is merged into master.

VincentVelthuizen commented 7 years ago

The above workflow implies "checking" can only be done when a "version" has been finished. That might inefficient, especially since every chapter should never have forward dependencies (it might have backwards ones).

VincentVelthuizen commented 7 years ago

Let's do it like this: Luc and Nadia check the chapters within the branch in which they are being written. After that check the branch can be merged into 'dev'.

When all chapters for a milestone are done a delivery branch is created to be checked by Nick. Changes in this branch are primarily to hide stubs and other development artifacts that are not (yet) suitable for release. Spelling and grammatical changes should of course be merged back into dev.

After that the delivery branch can be merged into master.