Ticket link should always be included in PR description.
But branch names should be descriptive like terraform_dev_create_instance
etc
[feature/bug]/ISSUE-NUMBER-summary-of-issue
e.g.: bug/psi-456-broken-args-parsingThis reaction tells me a lot about the state of our industry. (Or just the state of my mind.)
With GitHub setup properly, on PR open, it auto comments the link to the ticket and links to the pr in the ticket.
``` issues/{username}/{issue-number}-{description} ```
The username prefix is helpful, for both organization, and locating branches.
In my org it is common to use the JIRA ticket number in there somewhere but other than that I think you should leave it up to devs. I can't think of a reason why I would need to know the branch name.
My favorite branch name I created was for a JIRA ticket with the number 2468.
This became ab-2468-who-do-we-appreciate
Detailed branch naming conventions are just another piece of useless documentation for devs. And if you are using the branch name to tell you what is going on the you are misunderstanding the review process.
I also like it for myself, when I’m going over my own PRs before asking for a review - I will often amend commits to ensure the work is broken down correctly, each thing that should go together, does.
In a way, stacked PRs are just a higher-level abstraction of this too - same idea, keep work that goes together in the same place.
If it has commits I care about, then it stays. If it doesn't, It goes. I'm only deleting on the server afterall, people can just push it back.
If you keep your PRs small I guess the end result is the same, but even then I like things in individual commits for ease of review.
You downvote me but you just agreed with me. When was the last time you read individual commits of a PR? If your PR need to keep the history of the commits that means that you should split your PR into smaller one.
The last time I read individual commits of a PR? Maybe two hours ago. Before that, maybe five hours ago. Not everyone works like you do. Some people like clean commits. As I said, it’s very helpful when reviewing a PR, for me. I never said it was helpful for you.
I just wanted to say thanks for all the comments and discussion. It’s been amazing (and honestly a bit surprising) to see so many developers checking it out.
The idea for gibr came from the frustration I had when I was forced to use Jira for issue tracking and GitLab for our repos. At the time, I built an internal tool called jig that integrated the two. With a single command, it could create a branch, push it, transition the Jira issue to In Progress, and open a merge request with everything pre-filled — assignee, reviewers, description, and so on. It became really popular at my company.
I decided to take that idea further and rebuild it as an open-source tool with a plugin architecture, so it could work with any issue tracker or Git provider, not just Jira and GitLab.
If anyone has feedback or ideas for new integrations, I’d love to hear them — some great suggestions have already come in that might make it into the next release.
Thanks again for the support — this community is awesome.
Also many people do not have the luxury of using Linear, many companies force developers to use Jira...
I have not gotten there yet though