- Keep PR Focused on one purpose (not a whole feature or a whole project)
- Don’t mix refactoring with making new logic. (Do a refactor first and then make the logic)
- Clenup what is only related to your PR
- Avoid unneccessary renames of variables and functions
- Comment where needed (High level comment)
- Keep PRs small
For writing and packaging prs
- Make sure your PR has a good title
- Add a clear PR summary (what you added, changed, deleted)
- Highlight non-obvious logic, if there was any trickery or non-obvious logic
- Be clear what you haven’t done (Like adding a TODO)
- Add images (for UI changes)
- Add testing instructions for new or complex features
- Add pre-hook, automated jobs, launching block tests
- Retest manually
Jump to a subject
Software engineering
Infrastructure & security
Computer science
Hardware & engineering