-
-
Notifications
You must be signed in to change notification settings - Fork 2.4k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add new issues templates #1503
Add new issues templates #1503
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Good idea. I've left a few comments. In general I'd keep those templates as slim as possible.
When contributing to a GitHub project myself, I don't want to read/fill-in 10 sections and a tick 20 performed checks.
.github/ISSUE_TEMPLATE/bug_report.md
Outdated
name: Bug report | ||
about: Create a report to help us improve Devdocs | ||
title: '' | ||
labels: '' |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Can we assign appropriate labels automatically?
.github/ISSUE_TEMPLATE/bug_report.md
Outdated
<!-- | ||
Verify this steps before writing a new issue | ||
|
||
- Update to the most recent master release; the bug may already be fixed. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This item is not relevant when people are using devdocs.io?
@@ -0,0 +1,8 @@ | |||
blank_issues_enabled: false | |||
contact_links: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Also link to contributing guidelines?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I do not think it is needed to add the contributing guidelines, the templates already have most of the information found in the guidelines and the information about how contributing with code is not needed to make a new issue.
name: Documentation style bug | ||
about: Report documentation that has lost its style |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
name: Documentation style bug | |
about: Report documentation that has lost its style | |
name: Documentation bug | |
about: Report a problem with a specific documentation |
Since the problem could also be:
- documentation is missing a page
- documentation is missing a sidebar entry
- ...?
All of your suggestions were added, check them and let me know if something should be changed. |
These new issues templates could help to get better information about bugs and documentation styles. This also could help to avoid issues that are made requesting new docs and are almost inmediatly close (since the procedure to request a new doc isn't create a new issue)