Update the pr template to include clear section delineation and other potential improvements.
I think that with these changes, it is simpler for the submitter to see what they must "check off", and easier for reviewers to see which boxes need to be checked off for that submission. In particular, this will make reviewing updates and fixes extremely easy.
I also fixed a link to the title-casing website, that one seemed dead so I just added a general description reference.
The new PR template would be (as code):
<!-- Thank you for contributing to our list! -->
<!-- Please write a DESCRIPTIVE TITLE for the pull request and commits. -->
__Project name:__
__Project website/repository:__
__License:__
__Submission type:__
<!-- Submission type can be one of "New Software Project", "New Data Repository", "New Tutorial or Cheat Sheet", "New Miscellaneous", or "Fix/update existing entry" -->
<!-- In the following checklist, an empty check-box is "[ ]", a checked check-box is "[x]". You can also interactively click the boxes once the PR is submitted. -->
## Checklist for all pull requests:
<!-- If adding a project to the list, make sure it fulfills the following criteria. -->
<!-- Make sure it's "certified awesome"! -->
- [ ] Project is [`certified awesome`](awesome.md)
<!-- General requirements -->
- [ ] The project is [open-source](https://opensource.org/licenses/alphabetical) and accessible.
- [ ] Searched the existing entries to make sure this is not a duplicate.
- [ ] Contains only a single addition (make separate PRs if adding more than one).
- [ ] Added the link to the bottom of the relevant category.
- [ ] Created a new category only if necessary.
<!-- Formatting criteria -->
- [ ] Add icon from the `media/icon/` folder if applicable (e.g., `` ).
- [ ] Checked spelling and grammar.
- [ ] Removed trailing whitespace and periods.
- [ ] Confirm the dash – is not a minus -.
- [ ] Used [title-casing](https://apastyle.apa.org/style-grammar-guidelines/capitalization/title-case) (AP style) for project name.
### Checklist for new software projects:
- [ ] Link the code repository rather than the website/documentation
- [ ] Installation instructions present
- [ ] Documentation looks great
- [ ] Examples or Tutorials to follow
- [ ] Tests and Travis CI running
### Checklist for new Data Repositories, Tutorials and Cheat Sheets, and Miscellaneous:
- [ ] Easily accessible
- [ ] Comprehensive and widely appealing
Update the pr template to include clear section delineation and other potential improvements.
I think that with these changes, it is simpler for the submitter to see what they must "check off", and easier for reviewers to see which boxes need to be checked off for that submission. In particular, this will make reviewing updates and fixes extremely easy.
I also fixed a link to the title-casing website, that one seemed dead so I just added a general description reference.
The new PR template would be (as code):
and rendered:
Project name:
Project website/repository:
License:
Submission type:
Checklist for all pull requests:
certified awesomemedia/icon/folder if applicable (e.g.,).Checklist for new software projects:
Checklist for new Data Repositories, Tutorials and Cheat Sheets, and Miscellaneous: