Branch and Pull Request Naming

[nelsonic]

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 ... 😞

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:

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

[iteles]

https://github.com/dwyl/contributing/issues/109#issuecomment-440172867