Optional, e.g. issues the reviewers don't need to worry about because they are prevented by other means.
Implementation details
Optional, e.g. link to design documentation. diagrams etc. as well as additional hints to the reviewers e.g. where to focus when a high number of file is changed.
Integration test detail
Required, once the entire feature is available: how is integration testing performed, e.g. mention of the current repo test case and branch.
Checkpoints for reviewers
The PR mentions the issue when available (required for non-trivial pull requests)
The PR guidelines are followed (size is manageable, etc.), see https://github.com
The coding guidelines are followed (file and function comments, naming conventions etc.), see https://github.com
Overview
Links to issues, related PRs
none.
Description
Update documents.
Out of scope
Optional, e.g. issues the reviewers don't need to worry about because they are prevented by other means.
Implementation details
Optional, e.g. link to design documentation. diagrams etc. as well as additional hints to the reviewers e.g. where to focus when a high number of file is changed.
Integration test detail
Required, once the entire feature is available: how is integration testing performed, e.g. mention of the current repo test case and branch.
Checkpoints for reviewers