Better GitHub issue templates #1683
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
The [babel](https://github.com/babel/babel/issues/new/choose) project had a pretty neat idea for GitHub issue templates, so I'd like to adapt them for the Node.js website. As we receive issues for API docs (which are not hosted here) and other, it might be a good idea to guide the user to the right place directly.
tniessen
approved these changes
Jun 9, 2018
vsemozhetbyt
reviewed
Jun 9, 2018
.github/ISSUE_TEMPLATE.md
Outdated
| when you attach a screenshot as well. | ||
|
|
||
| Thank you! | ||
| Check the other issue templates if you are trying to submit a bug report, feature request, or question |
.github/ISSUE_TEMPLATE/api_docs.md
Outdated
| --- | ||
| <!-- | ||
| For issues regarding the Node.js API docs, please head over to: | ||
| https://github.com/nodejs/node/issues/ (prefix your issue name with "doc") |
| Before submitting, please have a look at the existing issues if there's already | ||
| something related to your suggestion. | ||
|
|
||
| We are also [working on a relaunch](https://github.com/nodejs/website-redesign/issues/) |
There was a problem hiding this comment.
Is it worth to replace the markdown markup in the comment with a more readable plain text?
.github/ISSUE_TEMPLATE/help.md
Outdated
|
|
||
| --- | ||
| <!-- | ||
| We have a special help section for general quesitons about Node.js: |
There was a problem hiding this comment.
quesitons -> questions.
|
@vsemozhetbyt Thanks, fixed! |
vsemozhetbyt
approved these changes
Jun 9, 2018
stevemao
approved these changes
Jun 9, 2018
ckotzbauer
approved these changes
Jun 9, 2018
Tsuna-mi
approved these changes
Jun 9, 2018
This was referenced May 4, 2021
This was referenced May 5, 2021
This was referenced Sep 27, 2021
This was referenced Oct 5, 2022
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The babel project had a pretty neat idea for GitHub issue templates, so I'd like to adapt them for the Node.js website.
As we receive issues for API docs (which are not hosted here) and other, it might be a good idea to guide the user to the right place directly.