Opened 51 minutes ago
#37158 new Cleanup/optimization
"All tickets" section of contributor checklist is below the fold
| Reported by: | Margaret Fero | Owned by: | |
|---|---|---|---|
| Component: | Documentation | Version: | 6.0 |
| Severity: | Normal | Keywords: | |
| Cc: | Margaret Fero | Triage Stage: | Unreviewed |
| Has patch: | no | Needs documentation: | no |
| Needs tests: | no | Patch needs improvement: | no |
| Easy pickings: | no | UI/UX: | no |
Description
The Contribution Checklist starts specific then goes more general as it continues: https://docs.djangoproject.com/en/dev/internals/contributing/writing-code/submitting-patches/#contribution-checklist . This means that as a new contributor coming in on a docs issue, I didn't realize there was an "All tickets" section after "All Code Contributions" until I had gotten all the way to submitting a PR that was autoclosed for not meeting requirements that hadn't been onscreen when I carefully read the Documentation section.
Instead, I would expect that things everyone needs to know would come first, followed by more specific things that only some people need, so readers can safely drop out once they've gotten specific advice on their particular issue type. In this case, I propose reordering the sections as follows:
- All tickets
- All code changes
- Documentation
- Bugs
- New features
- Deprecating a feature
Screenshot of what appears onscreen when viewing the Django Contribution Checklist Currently