search

spacetelescope / style-guides

An opinionated guide on how we work.
Creative Commons Attribution 4.0 International
55 stars 33 forks source link

Add "Branching" workflow to git workflow guide #108

Closed bourque closed 4 years ago

bourque commented 4 years ago

This PR modifies the existing git workflow guide to add a 'branching' workflow in addition to the 'forking' workflow. It does not explicitly state which workflow is preferred, but rather offers various pros/cons of using each.

See #32 for more context.

Closes #32.

pllim commented 4 years ago

@dpnemergut might want to have a look since he uses the branching workflow, I think.

bourque commented 4 years ago

@arfon @eteq @pllim @mperrin @dpnemergut As people who have been vocal on #32, could one or more of you offer a review here? I tried to compile a lot of what was said there into the pros/cons list. Please let me know if I am missing anything or if anything should be re-worded. Thanks!

pllim commented 4 years ago

Just want to note that the fact that this PR about branching workflow is made from a fork did not escape me... 😉

bourque commented 4 years ago

Thank you for all of the comments @pllim and @mperrin! I will digest these, make some edits, and get back to you.

bourque commented 4 years ago

@pllim @mperrin @dpnemergut I pushed some updates that hopefully address most or all of your suggestions. Please let me know if you have any further suggestions/comments in the next week, if you can. I am taking next week off, but would like to get this merged shortly after I return, if possible. Thanks!

bourque commented 4 years ago

Misc comments attached.

I'm honestly kind of ambivalent about this all. But perhaps I just don't understand the specific problem this is trying to solve. I am glad there is no attempt to dictate the use of one or the other workflow; different things work for different projects and different teams. And there are variants of these as well. So I'm fine with this as a descriptive style guide; but I am more hesitant about the idea of making anything more proscriptive "you must do exactly either A or B".

@mperrin I just wanted to chime in here and say that I definitely agree with this sentiment. I hope that the recent change to remove the explicit pros/cons list and instead just list a 'few things to consider' makes it clear that this style guide has no preference to a particular workflow.

bourque commented 4 years ago

Alrighty, thanks again for the feedback. I'm considering this good to go!