Issue Templates #930

aniculescu · 2022-10-12T14:46:56Z

From issue #865, this PR introduces two templates:

Bugs
Default

Sample screenshot:

Additionally, a small update to docs (contributing.md) to reflect these changes.

dherman

Thank you for this contribution! I did not know how the issue template configuration format worked, so I appreciate you diving in and figuring it out. I've made a few suggestions to try to optimize the balance of the informative/expensive ROI ratio, but I really like the general direction.

.github/ISSUE_TEMPLATE/bug_report.yml

dherman · 2022-11-11T18:16:53Z

.github/ISSUE_TEMPLATE/bug_report.yml

+        **Note**: We encourage you to [submit an RFC](https://github.com/neon-bindings/rfcs) if you would like to propose a **design change** or a **new feature** for the Neon API or the Neon command-line tool.
+        ______
+
+        In addition to the `bug` label, consider adding others you might find relevant:


This table is nice documentation for us to have somewhere, but I don't think it belongs in our issue template. I don't think we have a way to enable non-maintainers to attach labels, and I think the ROI isn't there anyway (the benefit of getting help with triage doesn't pay for the friction it adds to casually filing issues).

Good feedback, thanks. I was struggling to maintain that same ratio, ultimately I figured it's easier to cut things out than not have enough detail. Maybe the labels table is best moved to the contributing doc?

dherman · 2022-11-11T18:20:27Z

.github/ISSUE_TEMPLATE/bug_report.yml

+        Thanks in advance for taking the time to file this issue!
+        We hope this simple template will improve issue resolution time and minimize the need for _context discovery_ discussions.
+        ______
+        **Note**: We encourage you to [submit an RFC](https://github.com/neon-bindings/rfcs) if you would like to propose a **design change** or a **new feature** for the Neon API or the Neon command-line tool.


Why don't we add just one more category for Feature Requests and add this note to that one instead. For bug reports I don't think they'll generally need an RFC.

👍 - Probably not worded great, but the intent was to say: don't use a bug template to describe a more fundamental change. I"ll add the feature_request type.

dherman · 2022-11-11T18:21:04Z

.github/ISSUE_TEMPLATE/default_issue.yml

@@ -0,0 +1,61 @@
+name: New Issue


Why don't we call this "All Other Issues" or something like that, to make it really clear that it's the catch-all case.

dherman · 2022-11-11T18:21:33Z

.github/ISSUE_TEMPLATE/default_issue.yml

+  - type: markdown
+    attributes:
+      value: |
+        Thanks in advance for taking the time to file this issue! 


Let's make the structure for this kind of issue report extremely minimal, so that we minimize the risk of people giving up on filing issues.

I think this is a good idea. Make the "other" issue nothing but an open text field.

dherman · 2022-11-11T18:21:57Z

.github/ISSUE_TEMPLATE/bug_report.yml

+  - type: input
+    id: npm_version
+    attributes:
+      label: "Node Package Manager version: "


I think "Node" here is unnecessary, just "Package Manager version" is good.

Perhaps just "Package Manager" to make space for alternate package managers (yarn, pnpm).

attributes: label: "Package Manage: " description: "Please specify the package manager and version you are running (`npm -v`)" placeholder: "npm 8.19.2"

attributes: label: "Package Manager & version: " description: "Please specify the package manager your are using and its version" placeholder: "example: npm 8.19.2"

How's this?

dherman · 2022-11-11T18:22:27Z

CONTRIBUTING.md

@@ -6,10 +6,11 @@ Neon welcomes contribution from everyone. Here are some resources to help you jo

 ### Issue reports

-We welcome issues and aim to keep the barrier low. Just [file a GitHub issue](https://github.com/neon-bindings/neon/issues)
-like normal---we don't require issue templates or have any particular process.
+We welcome issues and aim to keep the barrier low. For clarity and efficiency, we created two simple issue templates:


If we add a third, then s/two/three/

dherman · 2022-11-11T18:22:40Z

CONTRIBUTING.md

-like normal---we don't require issue templates or have any particular process.
+We welcome issues and aim to keep the barrier low. For clarity and efficiency, we created two simple issue templates:
+ - [Bug Report](https://github.com/neon-bindings/issues/new?assignees=&labels=bug&template=bug_report.yml&title=🐛+%5BBUG%5D+-+<title>)
+ - [General Neon Issue](https://github.com/neon-bindings/issues/new?assignees=&labels=&template=default_issue.yml&title=Neon+Issue)


(If we add a third, add the text here)

dherman · 2022-11-11T18:23:15Z

CONTRIBUTING.md


-That said, the more information you can provide to help us reproduce your issue, the better!
+The more information you can provide, the better! Thanks in advance! ❤️


How about "The more information you can provide, the better we can help you get your issue resolved!" so we explain it explicitly in terms of how we are here to help the contributor?

kjvalencik · 2022-11-11T18:26:26Z

.github/ISSUE_TEMPLATE/bug_report.yml

+  - type: input
+    id: neon_version
+    attributes:
+      label: "NEON version(s): "


Suggested change

label: "NEON version(s): "

label: "Neon version(s): "

kjvalencik · 2022-11-11T18:29:37Z

.github/ISSUE_TEMPLATE/bug_report.yml

+  - type: input
+    id: npm_version
+    attributes:
+      label: "Node Package Manager version: "


Perhaps just "Package Manager" to make space for alternate package managers (yarn, pnpm).

attributes: label: "Package Manage: " description: "Please specify the package manager and version you are running (`npm -v`)" placeholder: "npm 8.19.2"

kjvalencik · 2022-11-11T18:30:22Z

.github/ISSUE_TEMPLATE/default_issue.yml

+  - type: markdown
+    attributes:
+      value: |
+        Thanks in advance for taking the time to file this issue! 


I think this is a good idea. Make the "other" issue nothing but an open text field.

aniculescu added 2 commits October 12, 2022 07:41

Created two issue templates and updated the contribution doc. Fixes: n…

aa17a48

…eon-bindings#865

Prettier formatting

0be5050

dherman requested changes Nov 11, 2022

View reviewed changes

kjvalencik reviewed Nov 11, 2022

View reviewed changes

aniculescu added 5 commits November 12, 2022 07:00

Remove labels table from bug issue template

7c1fb0f

Simplify the default template, per comments

c621b4b

Feature Request issue template

637eb87

Addressing feedback and linking the new feature request template

96a8044

Linting :(

f66fd07

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Issue Templates #930

Issue Templates #930

aniculescu commented Oct 12, 2022

dherman left a comment

dherman Nov 11, 2022

aniculescu Nov 11, 2022

dherman Nov 11, 2022

aniculescu Nov 11, 2022

dherman Nov 11, 2022

dherman Nov 11, 2022

kjvalencik Nov 11, 2022

dherman Nov 11, 2022

kjvalencik Nov 11, 2022

aniculescu Nov 13, 2022

dherman Nov 11, 2022

dherman Nov 11, 2022

dherman Nov 11, 2022

kjvalencik Nov 11, 2022

kjvalencik Nov 11, 2022

kjvalencik Nov 11, 2022


		That said, the more information you can provide to help us reproduce your issue, the better!
		The more information you can provide, the better! Thanks in advance! ❤️

Issue Templates #930

Are you sure you want to change the base?

Issue Templates #930

Conversation

aniculescu commented Oct 12, 2022

dherman left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment