Proper documentations on Pull Requests (PR) and commits can be argued to be as important as code documentations. It is common for engineers to work on multiple projects or having responsibilities on multiple projects e.g., having to go back to fix a bug on an older project especially when the team is small. Moreover, there are cases where developers who review your PR aren’t necessarily someone that is also actively working on the repo so having a well documented PR will help them know what the PR is about and the feature(s) it contains with ease.
The chances of forgetting something increase as time passes as well. This obstacle will be particularly apparent if one has to go back to an old project to fix, improve or revert something, so a good record of well documented PR(s) and commits will be a huge time-saver. Therefore, with all this in mind we should make an effort to make it easier for developers to go through a repo’s history so it makes everyone’s job easier and more enjoyable which in turn saves cost.
Ideally, we should set up PR templates for each repo on GitHub.
When writing a new feature or PR always keep in mind that we tend to build things for scale so your PR should have scale in mind.
<aside> ⚠️ Please always make sure to double check and ideally test your commits and PRs before asking for reviews to save time for everyone involved
</aside>