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 templates #30

Closed
wants to merge 1 commit into from
Closed

feat: add GitHub templates #30

wants to merge 1 commit into from

Conversation

NozomuIkuta
Copy link
Member

Resolves #28

I got emoji reactions to the issue from @pi0 and @danielroe, which is why I created this PR.

I added GitHub Issues/PR templates mainly based on unjs/nitro with some modifications.

You can check how these templates look like in NozomuIkuta/unjs-template-playground.

Comment on lines +3 to +4
# Labels must be prepared in advance, otherwise no labels are applied
labels: ["pending triage"]
Copy link
Member Author

Choose a reason for hiding this comment

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

Added an instruction.

Comment on lines +6 to +8
- type: markdown
attributes:
value: Thank you for taking the time to fill out this bug report!
Copy link
Member Author

Choose a reason for hiding this comment

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

Nitro's template shows the content below instead:

If bug-report is related to Nuxt framework, please open an issue directly there:
https://github.com/nuxt/framework/issues/new/choose

My PR shows the same content as Nitro's feature request template.

Which should I set up?

Copy link
Member Author

Choose a reason for hiding this comment

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

@danielroe
Copy link
Member

This looks great - and thank you for reading the emoji signals 😁

Comment on lines +1 to +10
# contact_links:
# # GitHub Discussions is disabled by default. You should enabled it fist otherwise 404 page is shown.
# - name: 💬 Discussions
# url: https://github.com/unjs/packageName/discussions
# about: Use discussions if you have an idea for improvement and asking questions

# # You might need this link in case this package is integrated into Nuxt
# - name: 🔗 Nuxt related Issues
# url: https://github.com/nuxt/framework/issues/new/choose
# about: Please open an issue in nuxt/framework to discuss
Copy link
Member Author

@NozomuIkuta NozomuIkuta Nov 29, 2022

Choose a reason for hiding this comment

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

I disable them by default, because the link to GitHub Discussion doesn't work at first, and because I didn't think that unjs packages are necessarily integrated into Nuxt.

@codecov
Copy link

codecov bot commented Nov 29, 2022

Codecov Report

Merging #30 (b1adb2f) into main (7739a8b) will not change coverage.
The diff coverage is n/a.

@@            Coverage Diff            @@
##              main       #30   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files            1         1           
  Lines            3         3           
  Branches         2         2           
=========================================
  Hits             3         3           

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

Comment on lines +36 to +38
- [ ] I have linked an issue or discussion.
- [ ] I have updated the documentation accordingly.
- [ ] I have updated tests and/or playground accordingly.
Copy link
Member Author

Choose a reason for hiding this comment

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

I added a check box for PR testing.

@pi0
Copy link
Member

pi0 commented Nov 30, 2022

Thanks for this @NozomuIkuta 🚀 I have cross merged your works to unjs/.github as unjs/.github@b866bd9 which enables issue templates for all repositories by default (it can be overridden by each repo for instance Nitro)

@pi0 pi0 closed this Nov 30, 2022
@NozomuIkuta NozomuIkuta deleted the feat/add-github-templates branch November 30, 2022 09:55
@NozomuIkuta
Copy link
Member Author

@pi0

Ohh, I didn't know that we can set up organization-level .github/* configuration! 😲
Yes, that's much better and maintainable way to apply template to all the repositories 👍

Thank you to adopt my PR. 🙋‍♂️

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.

feat: add GitHub templates
3 participants