-
Notifications
You must be signed in to change notification settings - Fork 29.7k
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 multiple issue templates #22215
Add multiple issue templates #22215
Conversation
Are we sure links will render correctly with the exclamation point at the end of them? |
@mscdex They do in the GitHub markdown editor. |
--> | ||
|
||
**Is your feature request related to a problem? Please describe.** | ||
Please describe what the problem is you are trying to solve. |
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.
Please describe what is the problem you are trying to solve? Though not a native speaker.
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 think line 13 is sufficiently clear that line 14 isn't really necessary.
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.
How about: Please describe the problem you are trying to solve.
?
Please describe what the problem is you are trying to solve. | ||
|
||
**Describe the solution you'd like** | ||
Please describe what you want to happen. |
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.
Please describe what do you want to happen?
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.
Maybe Please describe the desired behavior.
?
--- | ||
|
||
<!-- | ||
Thank you for sugesting an idea to make Node.js better. |
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.
sugesting -> suggesting
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.
LGTM! 🎉
A few minor nits below:
<!-- | ||
Thank you for reporting a possible bug in Node.js. | ||
|
||
Please fill in as much of the template below as you're able. |
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.
nit: able.
-> able to.
+ same throughout
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.
nit:
able.
->able to.
+ same throughout
I'm mildly opposed to adding to
.
If ending with able
seems awkward or unclear, maybe as much as you're able
-> as much as you can
?
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.
+1 on as much as you can
. Otherwise I would also stumble upon the sentence.
|
||
Version: output of `node -v` | ||
Platform: output of `uname -a` (UNIX), or version and 32 or 64-bit (Windows) | ||
Subsystem: if known, please specify affected core module name |
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.
nit: specify affected
-> specify the affected
Platform: output of `uname -a` (UNIX), or version and 32 or 64-bit (Windows) | ||
Subsystem: if known, please specify affected core module name | ||
|
||
If possible, please provide code that demonstrates the problem, keeping it as |
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.
nit: provide code
-> provide the code
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'm mildly opposed to this nit too. Just provide code
.
* **Platform**: | ||
* **Subsystem**: | ||
|
||
<!-- Enter your issue details below this comment. --> |
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.
nit: Enter your issue details
-> Please provide more details
@sagirk All of the nits you listed already existed in the old issue template. Can someone from nodejs/collaborators confirm that these should be changed? |
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.
LGTM. I'm sure we'll want to iterate on these as we see how they work.
38fa282
to
166a1dc
Compare
Thanks, @Trott. The filenames were generated by the GitHub wizard, I assume it is safe to change them, but I have no idea whether that would interfere with GitHub tools later on. |
@tniessen you can replace the first two dashes with a number e.g. |
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.
LGTM but it would be nice to have the nit addressed.
<!-- | ||
Thank you for reporting a possible bug in Node.js. | ||
|
||
Please fill in as much of the template below as you're able. |
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.
+1 on as much as you can
. Otherwise I would also stumble upon the sentence.
--- | ||
|
||
If you have a question about Node.js that is not a bug report or feature | ||
request, please post it in https://github.com/nodejs/help! |
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.
Maybe also add in this and the node.js org one that this will be closed if opened?
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.
Still LGTM
Fixes: #21812 PR-URL: #22215 Reviewed-By: Rich Trott <rtrott@gmail.com> Reviewed-By: Gus Caplan <me@gus.host> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de> Reviewed-By: George Adams <george.adams@uk.ibm.com> Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com>
Landed in 3ce9275 |
Fixes: #21812 PR-URL: #22215 Reviewed-By: Rich Trott <rtrott@gmail.com> Reviewed-By: Gus Caplan <me@gus.host> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de> Reviewed-By: George Adams <george.adams@uk.ibm.com> Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com>
An initial attempt at using the new issue template tool provided by GitHub. I created the commits using the GitHub template wizard, I can take care of fixing the commit message if we decide to land this.
Looking forward to feedback and suggestions!
Fixes: #21812