Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Branch and Pull Request Naming #100

Open
nelsonic opened this issue Aug 4, 2017 · 1 comment
Open

Branch and Pull Request Naming #100

nelsonic opened this issue Aug 4, 2017 · 1 comment

Comments

@nelsonic
Copy link
Member

nelsonic commented Aug 4, 2017

We have notes creating Good Pull Requests:
github.com/dwyl/contributing#notes-on-creating-good-pull-requests
However we are still getting PRs that are named in an unhelpful way ... 😞
poor-branch-and-pr-name

What does a branch (and corresponding pull request) named "test" add to (fix or remove from) the project?

People keep forgetting that the purpose of writing code
and (then) getting it merged it into a project
is to communicate as much as possible with teammates.

"Programs must be written for people to read, and only incidentally for machines to execute." ~ Harold Abelson

"Any fool can write code that a computer can understand. Good programmers write code that humans can understand." ~ Martin Fowler

Some teams/organisations have a branch naming convention
e.g: https://github.com/agis/git-style-guide#branches

@nvie has a detailed post on this: http://nvie.com/posts/a-successful-git-branching-model
however I would not describe it as "beginner friendly" ... we should encourage people to read it as "further" or "background" reading, but we should distill it to a simple rule that anyone can follow without "advanced" git knowledge.

Proposal for Git Branch Naming

  • Git branches should be named descriptively.
  • Avoid one word names like test or fix.
  • Include the issue number in the branch name

A good (descriptive/helpful) branch name and PR name/description:
image

Note: I am guilty of using branch names that are not "team friendly" so trying not to "throw stones".

@iteles
Copy link
Member

iteles commented Dec 2, 2018

#109 (comment)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants