opensearch-project / opensearch-project/.github
Checklists in PR template are annoying, get rid of them and change for humanly readable reminders
Nobody has claimed this yet.
- Dominant language
- No language data
- Stars
- 41
- Forks
- 74
- Avg merge
- 3d 19h
- Merged PRs (30d)
- 1
Description
We see some variations of users going crafty and checklists in PR templates.
https://github.com/opensearch-project/OpenSearch/pull/1103
https://github.com/opensearch-project/OpenSearch/pull/1091
https://github.com/opensearch-project/OpenSearch/pull/1102
https://github.com/opensearch-project/opensearch-build/pull/203
They also show up as a task checklist in the list of PRs, which is misleading.
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
Start by locating the pull request template resources in the .github repository and review how the current checklist text is rendered in pull requests. Replace the checklist-style reminders with human-readable reminders, then verify that rendered pull requests no longer display misleading task checklists.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100