Create an org-wide PR template?
Open
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 4
- Forks
- 33
- Avg merge
- 3d 54m
- Merged PRs (30d)
- 2
Description
As a result of https://github.com/edx/open-edx-proposals/issues/171, an initial pull request template was introduced to edx-platform.
Acceptance criteria:
- Determine whether the PR template is being used consistently.
- If so: Make it the default template across all Open edX repositories (using
.githubmeta-repository?). Repositories should be able to opt-out of the template or use a custom one if they so choose. - If not: Choose to either (1) use linting to enforce the template, (2) find out why the template isn't being used and improve it, or (3) delete the template.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Review the proposal in open-edx-proposals#171 and the existing edx-platform/.github/pull_request_template.md first. Determine whether the template is used consistently across Open edX repositories, then document the decision and implement the selected organization-wide approach through the .github meta-repository or the stated alternatives. Done means the consistency question is answered and one acceptance-criteria path is completed.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- github
- Domain
- developer-experience, tooling
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 30/100