search

chingu-voyages / v50-tier3-team-24

Annotate articles with live, scrolling notes
2 stars 3 forks source link

adds mikeys name to readme #19

Closed mnichols08 closed 3 weeks ago

mnichols08 commented 3 weeks ago

I am not going to merge this for the sake of providing an example of what I believe to be an effective branch naming convention.

I find it is often really useful to lead your branch name with the "issue number" provided by GitHub when an issue is created. <issue-number>/<issue-type> Next by providing a / (forward slash) followed by <issue-type> we can specify what type of issue the branch is solving, followed by a <description-of-the-issue> and finally another / (forward slash) with username or initials as a means to distinguish the branch from others.

This results in a branch naming convention that leaves branches following this template <issue-number>/<issue-type>/<description-of-issue>/<user-initials>

This policy will make it easier to decipher what a branch consists of

davideastmond commented 3 weeks ago

I like this format but I am wondering if we can start with the feature and then the issue number? Ex. feat/3/add-do-something/de

mnichols08 commented 3 weeks ago

I like this format but I am wondering if we can start with the feature and then the issue number? Ex. feat/3/add-do-something/de

It should be a group decision Set Up a Team Workflow #9