json-schema-org / json-schema-org/website
Suggested changes to the issue templates
Nobody has claimed this yet.
- Dominant language
- HTML
- Stars
- 169
- Forks
- 484
- Avg merge
- 2d 2h
- Merged PRs (30d)
- 6
Description
I have a couple of suggestions for changes we can make to the issue templates that I hope will improve the quality of interactions with new contributors.
The bug_report and feature_request templates include, "Are you working on this? yes/no". This leads people to think that it's acceptable to start work on something without it being triaged and assigned. I suggest changing this to something like, "Are you interested in working on this once it's been triaged and accepted/verified? yes/no". I'm hoping that will lead people more in the right direction.
A problem we have far too often is people tagging not just maintainers, but also random people. I suggest adding a checkbox with a label something like, "I understand that maintainers are notified when I create an issue and I will NOT tag anyone in this issue or in Slack just to notify them that I created an issue". That could be worded better, but you get the idea. This should be added to all PR template types.
I'm sure there are other improvements that can be made as well, but those are my suggestions.
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 bug_report and feature_request issue templates, then inspect all PR template types mentioned in the issue. Start by comparing their current questions and notification guidance; done means the requested triage wording and no-tagging acknowledgment are consistently represented across the relevant templates.
Written by the indexing model from the issue text.
Assessment
- Domain
- developer-experience
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100