From a0e886279095eb7ecc6d40f693c2d5bb020c9481 Mon Sep 17 00:00:00 2001 From: Maria Grimaldi Date: Mon, 9 Dec 2024 19:56:33 +0100 Subject: [PATCH 1/3] docs: update template to reflect merge requirements for repo --- .github/PULL_REQUEST_TEMPLATE.md | 73 ++++++++++++++++++++++---------- 1 file changed, 51 insertions(+), 22 deletions(-) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 57a191dd..1c4615d3 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,39 +1,68 @@ -**Description:** Describe in a couple of sentences what this PR adds + -**Installation instructions:** List any non-trivial installation -instructions. +## Description -**Testing instructions:** +Describe what this pull request changes, and why. Include implications for people using this change. +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. -1. Open page A -2. Do thing B -3. Expect C to happen -4. If D happened instead - check failed. +Useful information to include: -**Reviewers:** -- [ ] tag reviewer -- [ ] tag reviewer +- Motivation and context of the implementation +- What's the intended use of this change? +- Use cases and usage examples available -**Merge checklist:** +## Supporting information + +Link to other information about the change, such as Jira issues, GitHub issues, or Discourse discussions. Also, link to any relevant documentation useful for reviewers. +Be sure to check they are publicly readable, or if not, repeat the information here. + +## Testing instructions + +Please provide detailed step-by-step instructions for testing this change, including any necessary setup or configuration. + +## Deadline + +"None" if there's no rush, or provide a specific date or event (and reason) if there is one. + +## Other information + +Include anything else that will help reviewers and consumers understand the change. + +- Any other PRs or issues that should be linked here? Any related PRs? +- Any special concerns or limitations? For example: deprecations, migrations, security, or accessibility. List any concern about this PR here, e.g. inelegant solutions, hacks, quick-and-dirty implementations, concerns about migrations, etc. + +## Checklists + +Check off if complete *or* not applicable: + +**Merge Checklist:** - [ ] All reviewers approved +- [ ] Reviewer tested the code following the testing instructions - [ ] CI build is green - [ ] Version bumped -- [ ] Changelog record added +- [ ] Changelog record added with short description of the change and current date - [ ] Documentation updated (not only docstrings) -- [ ] Commits are squashed +- [ ] Code dependencies reviewed +- [ ] Fixup commits are squashed away +- [ ] Unit tests added/updated +- [ ] Noted any: Concerns, dependencies, migration issues, deadlines, tickets -**Post merge:** +**Post Merge:** - [ ] Create a tag +- [ ] Create a release on GitHub - [ ] Check new version is pushed to PyPI after tag-triggered build is finished. - [ ] Delete working branch (if not needed anymore) - -**Author concerns:** List any concerns about this PR - inelegant -solutions, hacks, quick-and-dirty implementations, concerns about -migrations, etc. +- [ ] Upgrade the package in the Open edX platform requirements (if applicable) From 65bf2992917ef9665f84703a476d689b24a29503 Mon Sep 17 00:00:00 2001 From: Maria Grimaldi Date: Tue, 10 Dec 2024 13:47:47 +0100 Subject: [PATCH 2/3] docs: add references to main docs to PR template --- .github/PULL_REQUEST_TEMPLATE.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 1c4615d3..d3d961ce 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -8,6 +8,10 @@ Use this template as a guide. Omit sections that don't apply. You may link to information rather than copy it, but only if the link is publicly readable. If the linked information must be private (because it contains secrets), clearly label the link as private. +Fore more details on the Hooks Extension Framework contribution process, see: + +https://docs.openedx.org/en/latest/developers/concepts/hooks_extension_framework.html + --> ## Description From c452649c712699b04138530d61398d73f7038630 Mon Sep 17 00:00:00 2001 From: Maria Grimaldi Date: Tue, 10 Dec 2024 13:58:23 +0100 Subject: [PATCH 3/3] docs: be specific in testing instructions --- .github/PULL_REQUEST_TEMPLATE.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index d3d961ce..c5037514 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -34,7 +34,7 @@ Be sure to check they are publicly readable, or if not, repeat the information h ## Testing instructions -Please provide detailed step-by-step instructions for testing this change, including any necessary setup or configuration. +Please provide detailed step-by-step instructions for testing this change, including any necessary setup, e.g., additional requirements, plugins, configuration variables, etc, and environment details to ensure the reviewer can test the change. ## Deadline @@ -45,7 +45,7 @@ Please provide detailed step-by-step instructions for testing this change, inclu Include anything else that will help reviewers and consumers understand the change. - Any other PRs or issues that should be linked here? Any related PRs? -- Any special concerns or limitations? For example: deprecations, migrations, security, or accessibility. List any concern about this PR here, e.g. inelegant solutions, hacks, quick-and-dirty implementations, concerns about migrations, etc. +- Any special concerns or limitations? For example: deprecations, security, or anything you think should be noted. ## Checklists