Skip to content
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

feat: add GitHub Issue template #5

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

shinGangan
Copy link
Contributor

πŸ”— Linked issue

related #4 .

❓ Type of change

  • πŸ“– Documentation (updates to the documentation or readme)
  • 🐞 Bug fix (a non-breaking change that fixes an issue)
  • πŸ‘Œ Enhancement (improving an existing functionality)
  • ✨ New feature (a non-breaking change that adds functionality)
  • 🧹 Chore (updates to the build process or auxiliary tools and libraries)
  • ⚠️ Breaking change (fix or feature that would cause existing functionality to change)

πŸ“š Description

GitHub Issue template has been added.

It would be a pain to prepare a generic version for all repositories, so I've copied the contents of the Nuxt repo as is.

I think it's fine to have each repository make changes as needed.

@shinGangan shinGangan changed the title feat: add Issue template feat: add GitHub Issue template Jul 23, 2024
@shinGangan
Copy link
Contributor Author

Hi @danielroe , please review when you have a time πŸ™

πŸ‘‰ 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
Copy link
Member

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?

Copy link
Contributor Author

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?

Please use a template below to create a minimal reproduction
πŸ‘‰ https://stackblitz.com/github/${repo_name}
πŸ‘‰ https://codesandbox.io/s/github/${repo_name}

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

Copy link
Contributor Author

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

Copy link
Member

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.

Copy link
Contributor Author

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants