-
Notifications
You must be signed in to change notification settings - Fork 6
feat: add GitHub Issue template #5
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
Open
shinGangan
wants to merge
1
commit into
nuxt:main
Choose a base branch
from
shinGangan:feat/add-issue-template
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,49 @@ | ||
| name: '🐞 Bug report' | ||
| description: Create a report to help us improve Nuxt | ||
| labels: ['pending triage'] | ||
| body: | ||
| - type: markdown | ||
| attributes: | ||
| value: | | ||
| Please carefully read the contribution docs before creating a bug report | ||
| 👉 https://nuxt.com/docs/community/reporting-bugs | ||
|
|
||
| Please use a template below to create a minimal reproduction | ||
| 👉 https://stackblitz.com/github/nuxt/starter/tree/v3 | ||
| 👉 https://codesandbox.io/s/github/nuxt/starter/tree/v3 | ||
| - type: textarea | ||
| id: bug-env | ||
| attributes: | ||
| label: Environment | ||
| description: You can use `npx nuxi info` to fill this section | ||
| placeholder: Environment | ||
| validations: | ||
| required: true | ||
| - type: textarea | ||
| id: reproduction | ||
| attributes: | ||
| label: Reproduction | ||
| description: Please provide a link to a repo that can reproduce the problem you ran into. A [**minimal reproduction**](https://nuxt.com/docs/community/reporting-bugs#create-a-minimal-reproduction) is required unless you are absolutely sure that the issue is obvious and the provided information is enough to understand the problem. If a report is vague (e.g. just a generic error message) and has no reproduction, it will receive a "need reproduction" label. If no reproduction is provided we might close it. | ||
| placeholder: Reproduction | ||
| validations: | ||
| required: true | ||
| - type: textarea | ||
| id: bug-description | ||
| attributes: | ||
| label: Describe the bug | ||
| description: A clear and concise description of what the bug is. If you intend to submit a PR for this issue, tell us in the description. Thanks! | ||
| placeholder: Bug description | ||
| validations: | ||
| required: true | ||
| - type: textarea | ||
| id: additonal | ||
| attributes: | ||
| label: Additional context | ||
| description: If applicable, add any other context about the problem here | ||
| - type: textarea | ||
| id: logs | ||
| attributes: | ||
| label: Logs | ||
| description: | | ||
| Optional if provided reproduction. Please try not to insert an image but copy paste the log text. | ||
| render: shell-script | ||
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,8 @@ | ||
| blank_issues_enabled: true | ||
| contact_links: | ||
| - name: 📚 Nuxt Documentation | ||
| url: https://nuxt.com/docs | ||
| about: Check the documentation for usage of Nuxt | ||
| - name: 💬 Discussions | ||
| url: https://github.com/nuxt/nuxt/discussions | ||
| about: Use discussions if you have another issue, an idea for improvement or for asking questions. |
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,37 @@ | ||
| name: '🚀 Feature request' | ||
| description: Suggest a feature that will improve Nuxt | ||
| labels: ['pending triage'] | ||
| body: | ||
| - type: markdown | ||
| attributes: | ||
| value: | | ||
| Thank you for taking the time to fill out this feature request! | ||
|
|
||
| Please carefully read the contribution docs before suggesting a new feature | ||
| 👉 https://nuxt.com/docs/community/contribution/#creating-an-issue | ||
| - type: textarea | ||
| id: feature-description | ||
| attributes: | ||
| label: Describe the feature | ||
| description: A clear and concise description of what you think would be a helpful addition to Nuxt, including the possible use cases and alternatives you have considered. If you have a working prototype or module that implements it, please include a link. | ||
| placeholder: Feature description | ||
| validations: | ||
| required: true | ||
| - type: checkboxes | ||
| id: additional-info | ||
| attributes: | ||
| label: Additional information | ||
| description: Additional information that helps us decide how to proceed. | ||
| options: | ||
| - label: Would you be willing to help implement this feature? | ||
| - label: Could this feature be implemented as a module? | ||
| - type: checkboxes | ||
| id: required-info | ||
| attributes: | ||
| label: Final checks | ||
| description: Before submitting, please make sure you do the following | ||
| options: | ||
| - label: Read the [contribution guide](https://nuxt.com/docs/community/contribution). | ||
| required: true | ||
| - label: Check existing [discussions](https://github.com/nuxt/nuxt/discussions) and [issues](https://github.com/nuxt/nuxt/issues). | ||
| required: true |
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.
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.
Do you think this (and other references) could be made generic? Maybe using a GitHub variable to reference the repo this is being used in?
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.
Is this what you have in mind?
I would also think this would be ideal, but I don't have a solution at the moment.
I think it's possible to create an issue using GitHub Actions, but I think it would be hard to use variables when using templates.
It would be nice if it could be achieved with Autolinks, but I haven't tried it yet...
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.
Another solution is to have the user enter stackblitz as input.
For example, Nuxt Scripts asks the user to enter it.
https://github.com/nuxt/scripts/blob/3c8838558debe268861e33e8a5abba02523aa36e/.github/ISSUE_TEMPLATE/bug-report.yml#L12-L18
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.
Exactly - I'd like to have the repo autofilled in the text of the template.
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 glad we were on the same idea.
I'll continue to investigate and consider this renovation.