Issue Templates #930
Issue Templates #930
Conversation
There was a problem hiding this comment.
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.
| **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: |
There was a problem hiding this comment.
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).
There was a problem hiding this comment.
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?
| 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. |
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
👍 - 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.
| @@ -0,0 +1,61 @@ | |||
| name: New Issue | |||
There was a problem hiding this comment.
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.
| - type: markdown | ||
| attributes: | ||
| value: | | ||
| Thanks in advance for taking the time to file this issue! |
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
I think this is a good idea. Make the "other" issue nothing but an open text field.
| - type: input | ||
| id: npm_version | ||
| attributes: | ||
| label: "Node Package Manager version: " |
There was a problem hiding this comment.
I think "Node" here is unnecessary, just "Package Manager version" is good.
There was a problem hiding this comment.
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"There was a problem hiding this comment.
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?
CONTRIBUTING.md
Outdated
| @@ -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: | |||
There was a problem hiding this comment.
If we add a third, then s/two/three/
CONTRIBUTING.md
Outdated
| 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) |
There was a problem hiding this comment.
(If we add a third, add the text here)
CONTRIBUTING.md
Outdated
|
|
||
| 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! ❤️ |
There was a problem hiding this comment.
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?
| - type: input | ||
| id: neon_version | ||
| attributes: | ||
| label: "NEON version(s): " |
There was a problem hiding this comment.
| label: "NEON version(s): " | |
| label: "Neon version(s): " |
| - type: input | ||
| id: npm_version | ||
| attributes: | ||
| label: "Node Package Manager version: " |
There was a problem hiding this comment.
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"| - type: markdown | ||
| attributes: | ||
| value: | | ||
| Thanks in advance for taking the time to file this issue! |
There was a problem hiding this comment.
I think this is a good idea. Make the "other" issue nothing but an open text field.
From issue #865, this PR introduces two templates:
Sample screenshot:
Additionally, a small update to docs (contributing.md) to reflect these changes.