-
Notifications
You must be signed in to change notification settings - Fork 15
PR Format Guidelines
Ananya edited this page Nov 26, 2022
·
1 revision
- Give a meaningful title to the PR
- If it's in the "work in progress" state, then add [WIP] prefix
- If the pull request "requires review", then add [RR] prefix
- Provide appropriate labels to the PR. If a generic label is not present, ask your mentor/reviewer to create one if need be.
- Add any additional labels to the PR like a bug, improvement etc.
- Follow the PR template. Not necessary though.
- Include the purpose of the Pull Request.
- Remember that anyone could be reading this Pull Request, so the content and tone may inform people who are not participating, now or later.
- Be explicit about what feedback you want, if any: a quick pair of π on the code, discussion on the technical approach, critique on design.
- @mention individuals that you specifically want to involve in the discussion.
- Mention the dependencies/utilities/services you have used in your work. For example - list the packages that you added in the package.json file or any third party service.
- If you have used any method in your code that can be improved in the future or any part of code that will need special attention in the future, mention it in the PR.
- The name of your git branch should provide a subtle hint about what it does.
- Before creating a PR, rebase your branch with the latest main to avoid any merge conflicts later on.
- Always use good commit messages.