Skip to content

Add multiple issue templates - #22215

Closed
tniessen wants to merge 4 commits into
nodejs:masterfrom
tniessen:add-multiple-issue-templates
Closed

Add multiple issue templates#22215
tniessen wants to merge 4 commits into
nodejs:masterfrom
tniessen:add-multiple-issue-templates

Conversation

@tniessen

Copy link
Copy Markdown
Member

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

@nodejs-github-botnodejs-github-bot added the meta Issues and PRs related to the general management of the project. label Aug 9, 2018
@nodejs-github-bot

Copy link
Copy Markdown
Collaborator

@mscdex

Copy link
Copy Markdown
Contributor

Are we sure links will render correctly with the exclamation point at the end of them?

@tniessen

Copy link
Copy Markdown
MemberAuthor

@mscdex They do in the GitHub markdown editor.

Copy link
Copy Markdown
Member

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.

Copy link
Copy Markdown
Member

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.

Copy link
Copy Markdown
Member

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.?

Copy link
Copy Markdown
Member

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?

Copy link
Copy Markdown
Member

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.?

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

sugesting -> suggesting

@sagirksagirk left a comment

Copy link
Copy Markdown
Contributor

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:

Copy link
Copy Markdown
Contributor

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

@TrottTrottAug 10, 2018

Copy link
Copy Markdown
Member

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?

Copy link
Copy Markdown
Member

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.

Copy link
Copy Markdown
Contributor

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

Copy link
Copy Markdown
Contributor

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

@TrottTrottAug 10, 2018

Copy link
Copy Markdown
Member

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.

Copy link
Copy Markdown
Contributor

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

@tniessen

Copy link
Copy Markdown
MemberAuthor

@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?

@TrottTrott left a comment

Copy link
Copy Markdown
Member

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.

@tniessen
tniessenforce-pushed the add-multiple-issue-templates branch from 38fa282 to 166a1dcCompareAugust 10, 2018 16:04
@tniessen

tniessen commented Aug 10, 2018

Copy link
Copy Markdown
MemberAuthor

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.

@devsnek

Copy link
Copy Markdown
Member

@tniessen you can replace the first two dashes with a number e.g. 01-bug-report.mjd and 02-help-me.md so that they appear in a certain order. it's not required of course.

@BridgeARBridgeAR left a comment

Copy link
Copy Markdown
Member

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.

Copy link
Copy Markdown
Member

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!

Copy link
Copy Markdown
Member

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?

@BridgeARBridgeAR left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Still LGTM

@BridgeARBridgeAR added the author ready PRs that have at least one approval, no pending requests for changes, and a CI started. label Aug 10, 2018
jasnell pushed a commit that referenced this pull request Aug 12, 2018
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>
@jasnell

Copy link
Copy Markdown
Member

Landed in 3ce9275

@jasnelljasnell closed this Aug 12, 2018
@rvaggrvagg mentioned this pull request Aug 13, 2018
rvagg pushed a commit that referenced this pull request Aug 13, 2018
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>
@tniessentniessen removed the author ready PRs that have at least one approval, no pending requests for changes, and a CI started. label Sep 12, 2018
firass111 pushed a commit to firass111/Project_node1 that referenced this pull request Apr 16, 2025
Fixes: nodejs/node#21812
PR-URL: nodejs/node#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>
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

metaIssues and PRs related to the general management of the project.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Create multiple issue templates

12 participants

@tniessen@nodejs-github-bot@mscdex@devsnek@jasnell@Trott@sagirk@BridgeAR@lundibundi@vsemozhetbyt@trivikr@gdams