-
Notifications
You must be signed in to change notification settings - Fork 21
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: update template to reflect merge requirements for repo
- Loading branch information
1 parent
d076783
commit a0e8862
Showing
1 changed file
with
51 additions
and
22 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,39 +1,68 @@ | ||
**Description:** Describe in a couple of sentences what this PR adds | ||
<!-- | ||
**ISSUE:** Link to GitHub issue | ||
Please give your pull request a short but descriptive title. | ||
Use conventional commits to separate and summarize commits logically: | ||
https://open-edx-proposals.readthedocs.io/en/latest/oep-0051-bp-conventional-commits.html | ||
**Dependencies:** dependencies on other outstanding PRs, issues, etc. | ||
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. | ||
**Merge deadline:** List merge deadline (if any) | ||
--> | ||
|
||
**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) |