diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 980980aded97..9b4b8efabca6 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -1,18 +1,25 @@ ## Description Describe what this pull request changes, and why. Include implications for people using this change. -Design decisions and their rationales should be be documented in the repo (docstring / ADR), per [OEP-19](https://open-edx-proposals.readthedocs.io/en/latest/oep-0019-bp-developer-documentation.html), and can be linked here. +Design decisions and their rationales should be documented in the repo (docstring / ADR), per +[OEP-19](https://open-edx-proposals.readthedocs.io/en/latest/oep-0019-bp-developer-documentation.html), and can be +linked here. Useful information to include: - Which edX user roles will this change impact? Common user roles are "Learner", "Course Author", "Developer", and "Operator". - Include screenshots for changes to the UI (ideally, both "before" and "after" screenshots, if applicable). -- Provide links to the description of corresponding configuration changes. Remember to correctly annotate these changes. +- Provide links to the description of corresponding configuration changes. Remember to correctly annotate these +changes. ## Supporting information