Useful GitHub Features – Jenny Wong
Issue templates are predefined files that you can add to your project to help people who are submitting issues. It acts like a helpful reminder to the issue writer to structure their issues in a particular way which helps people on the project with handy information.
You can treat the templates as a strict form that needs to be filled in, guidelines to remind people what to fill, or a checklist of things that should be included in any issue.
Whats great about them is that you can create different issue templates for different things. Common things include:
- Bug reporting
- Enhancement request
- New feature request
- Maintenance todos
- Documentation
- Support
At work, a lot of our client repos already make use of issue templates and I think that it is one place where issue template's as a feature shine. I would also say any open source projects can use issue templates to guide more informative issues from contributors.
I can see PR templates being useful for projects which have multiple agencies or multiple groups of developers working together. It can be a neat way to remind everyone to follow an agreed project workflow by having a checklist built into the PR template.
You can see this in action when you want to create a new issue in the Atom repo.
Read full article from Useful GitHub Features – Jenny Wong
No comments:
Post a Comment