When you submit a pull request to the project repository, it should provide all of the information necessary for one of your teammates to verify its completeness.
The description that you provide should be comprehensive enough to...
- Provide clarity to any potentially complex code.
- Explain reasons behind organizational or architectual decisions you made.
- Give context to what feature you were completing so that your teammate has a mental model before looking at the code.
You must provide clear steps for any teammate to test the code.
- System configuration.
- 3rd party libraries that need to be installed.
- Command line utilities to run.
- If there is a UI component, give clear instructions for steps to perform in the UI, and what they should expect to see as the outcome of those steps.
At the end of the PR description, you must provide a hyperlink to the ticket that contains a description of the feature you are working on.