search

coderxio / dailymed-api

REST API for DailyMed SPLs
https://coderx.io/
MIT License
12 stars 5 forks source link

Branch naming conventions #25

Open yevgenybulochnik opened 4 years ago

yevgenybulochnik commented 4 years ago

Proposal

Would propose we come up with some branch naming conventions. Maybe something like name/issue#/description. Food for though what do you guys think?

Rationale

This would better organize and identify branches in the repo. ref: https://stackoverflow.com/questions/273695/what-are-some-examples-of-commonly-used-practices-for-naming-git-branches

finish06 commented 4 years ago

I don't see the value in adding names. Github keeps track of commits. It blurs if if one person helps another person out in the PR. I don't have qualms with issue#/description, however is the plan still to delete branches once they are merged? That is what I have been doing it.

yevgenybulochnik commented 4 years ago

Couple value statement for this, right now its really only the three of us contributing to the repo, but as the number of contributors grows using authors names allows us to better differentiate branches and more easily speak with someone who authored a specific branch. The output of git branch -a also becomes more explicit. I know exactly who to talk to about specific code changes.

Lets say there is an issue and two contributors have differing viewpoints on how to solve that issue. Using author name would allow two different users to address the same issue in their own ways. Then the decision to merge will be based on the review/merits of either branch/approach. I think using the author name would make the branches look much cleaner, ie user/issue#1/some-approach and user2/issue#1/alternate-approach

Personally, I believe there is value in the author of a branch/PR to be the "owner" of those code changes. For me it easier to explain and justify my own code changes. When other users start putting commits into branches I think this actually muddies the waters more. For me I would rather see a PR comment or request for changes that I would then implement and explain as the author of the branch. If its something I cant figure then I would ask for additional assistance. This is just my personal preference tho.

Food for thought

finish06 commented 4 years ago

Okay. I have no qualms against it, just didn't see value. I think we should capture this in the Code Contribution guidelines. This is available in Insight > Community. Let's make the standard name/issue#/description.