Reviewing Pull Request etiquettes
We explore PR conventions, practices, share links to template examples and additional resources for better Software practices.
For developers that collaborate on codebase using Git, there is usually a need to make a Pull Request to inform other people working on the project about the changes one has made.
Sometimes the information on the Pull Request can be overwhelming as it appears to be too much (alias unnecessary) and sometimes it can be too little that it does not provide enough help for the reviewers. What are the necessary details needed on the PR to help the other people on the project review the proposed incoming change?
We will be exploring the following:
- What are the details essential to the PR?
- Exploring some of the PR Convention out there
- Sharing and reviewing some PR templates
- How to include a PR Template on your Git repo
- Share some additional reading resources
What are the details essential on a PR Imagine you are reviewing a proposed change to the codebase from one of the contributors, there are certain things you want to know before approving and merging.
You want to know what the changes are about. Is it a bug fix, a new feature, or perhaps a code refactor. You would want to know what the change was about and why the change was made. Are there tests written for the new code and how can you test it, if it is?
some of the essential information needed on the PR are:
Exploring some of the PR Convention out there Each team can have a PR convention for what they work with. We will be exploring some PR conventions out there. A team can select or modify one that works for them.
There are some of the conventions:
- Start branch name with a category name. For example, "fix-authentication-error"
- In writing commit messages, write in the present tense. For example, "fix verification error occurring for users with Facebook login"
- use an issue tracking ID in branch names.
- use only lower case alphanumeric characters.
- use a dash instead of space or understand to name a branch
PR Template links
Add a PR template to your repo steps
Reference and Further reading