Skip to content

docs: improving typos in ISSUE_TEMPLATE files #704

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

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 8 additions & 9 deletions .github/ISSUE_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,15 @@
<!--
👉🏽 Need support, advice, or help? Don't open an issue!
Head to StackOverflow or https://gitter.im/webpack/webpack.
Head to GitHub Discussions(https://github.com/webpack/webpack/discussions) or Stack Overflow(https://stackoverflow.com/questions/tagged/webpack)

Hey there!
Hey there! 👋

You arrived at this template because you felt none of the other options
matched the kind of issue you'd like to report. Please use this opportunity to
tell us about your particular type of issue so we can try to accommodate
similar issues in the future.
You arrived at this template because you felt none of the other options matched the kind of issue you'd like to report.

PLEASE do note, if you're using this to report an issue already covered by the
existing template types, your issue may be closed as invalid. Our issue
templates contain fields that help us help you, and without that important
Please use this opportunity to tell us about your particular type of issue so we can try to accommodate similar issues in the future.

PLEASE do note, if you're using this to report an issue already covered by the existing template types, your issue may be closed as invalid.

Our issue templates contain fields that help us help you, and without that important
info, we might as well be ice-skating uphill, carrying a wooly mammoth.
-->
27 changes: 13 additions & 14 deletions .github/ISSUE_TEMPLATE/BUG.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,32 +3,31 @@ name: 🐛 Bug Report
about: Something went awry and you'd like to tell us about it.
---

<!-- Please don't delete this template otherwise your issue will be closed immediately -->
<!-- Before creating an issue please make sure you are using the latest version of webpack. -->
<!-- Please do not delete this template, otherwise your issue may be closed immediately. -->
<!-- Before creating an issue, make sure you are using the latest version of webpack. -->

### Bug report

<!-- Please ask questions on discussions or StackOverflow. -->
<!-- Please ask questions in Discussions or on Stack Overflow. -->
<!-- https://github.com/webpack/webpack/discussions -->
<!-- https://stackoverflow.com/questions/ask?tags=webpack -->
<!-- Issues which contain questions or support requests will be closed. -->
<!-- Issues that contain questions or support requests will be closed. -->

### Actual Behavior

<!-- Explain exactly how it behaves -->
<!-- Explain exactly how it behaves. -->

### Expected Behavior

<!-- "It should work" is not a helpful explanation -->
<!-- Explain exactly how it should behave -->
<!-- "It should work" is not a helpful explanation. -->
<!-- Explain exactly how it should behave. -->

### How Do We Reproduce?

<!-- A great way to do this is to provide your configuration via a GitHub repository -->
<!-- The most helpful is a minimal reproduction with instructions on how to reproduce -->
<!-- Repositories with too many files or large `webpack.config.js` files are not suitable -->
<!-- Please only add small code snippets directly into this issue -->
<!-- https://gist.github.com is a good place for longer code snippets -->
<!-- If your issue is caused by a plugin or loader, please create an issue on the loader/plugin repository instead -->
<!-- A great way to do this is to provide your configuration via a GitHub repository. -->
<!-- Minimal reproductions with clear instructions on how to reproduce are the most helpful. -->
<!-- Repositories with too many files or large `webpack.config.js` files are not suitable. -->
<!-- Please include only small code snippets directly in this issue. -->
<!-- If your issue is caused by a plugin or loader, please create an issue in the corresponding repository instead. -->

### Please paste the results of `npx webpack info` here, and mention other relevant information
### Please paste the results of `npx webpack-cli info` here, and mention other relevant information.
12 changes: 6 additions & 6 deletions .github/ISSUE_TEMPLATE/DOCS.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,12 @@ name: 📚 Documentation
about: Are the docs lacking or missing something? Do they need some new 🔥 hotness? Tell us here.
---

<!-- Please don't delete this template otherwise your issue will be closed immediately -->
<!-- Before creating an issue please make sure you are using the latest version of webpack. -->
<!-- Please do not delete this template, otherwise your issue will be closed immediately. -->
<!-- Before creating an issue, make sure you are using the latest version of webpack. -->

Documentation Is:
Documentation is:

<!-- Please place an x (no spaces!) in all [ ] that apply -->
<!-- Please place an "x" (no spaces!) in all [ ] that apply -->

- [ ] Missing
- [ ] Needed
Expand All @@ -17,9 +17,9 @@ Documentation Is:

### Please Explain in Detail...

<!-- Please don't delete this template otherwise your issue will be closed immediately -->
<!-- Please ask questions in Discussions or on Stack Overflow. -->
<!-- https://github.com/webpack/webpack/discussions -->
<!-- https://stackoverflow.com/questions/ask?tags=webpack -->
<!-- Issues which contain questions or support requests will be closed. -->
<!-- Issues that contain questions or support requests will be closed. -->

### Your Proposal for Changes
12 changes: 7 additions & 5 deletions .github/ISSUE_TEMPLATE/FEATURE.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,16 +3,18 @@ name: ✨ Feature Request
about: Suggest an idea for this project
---

<!-- Please don't delete this template otherwise your issue will be closed immediately -->
<!-- Before creating an issue please make sure you are using the latest version of webpack. -->
<!-- Please do not delete this template, otherwise your issue may be closed immediately. -->
<!-- Before creating an issue, make sure you are using the latest version of webpack. -->

### Feature Proposal

<!-- Please ask questions on discussions or StackOverflow. -->
<!-- Please ask questions in Discussions or on Stack Overflow. -->
<!-- https://github.com/webpack/webpack/discussions -->
<!-- https://stackoverflow.com/questions/ask?tags=webpack -->
<!-- Issues which contain questions or support requests will be closed. -->
<!-- Issues that contain questions or support requests will be closed. -->

### Feature Use Case

### Please paste the results of `npx webpack info` here, and mention other relevant information
<!-- Describe the problem this feature would solve and how it would be used in practice. -->

### Please paste the results of `npx webpack-cli info` here, and mention other relevant information.
17 changes: 11 additions & 6 deletions .github/ISSUE_TEMPLATE/MODIFICATION.md
Original file line number Diff line number Diff line change
@@ -1,20 +1,25 @@
---
name: 🔧 Modification Request
about: Would you like something work differently? Have an alternative approach? This is the template for you.
about: Want something to work differently? Have an alternative approach? This is the template for you.
---

<!-- Please don't delete this template otherwise your issue will be closed immediately -->
<!-- Before creating an issue please make sure you are using the latest version of webpack. -->
<!-- Please do not delete this template, otherwise your issue may be closed immediately. -->
<!-- Before creating an issue, please make sure you are using the latest version of webpack. -->

### Modification Proposal

<!-- Please ask questions on discussions or StackOverflow. -->
<!-- Clearly describe the change you are proposing and why it's necessary. -->
<!-- Please ask questions in Discussions or on Stack Overflow. -->
<!-- https://github.com/webpack/webpack/discussions -->
<!-- https://stackoverflow.com/questions/ask?tags=webpack -->
<!-- Issues which contain questions or support requests will be closed. -->
<!-- Issues that contain questions or support requests will be closed. -->

### Expected Behavior / Situation

<!-- Describe how you expect the feature or behavior to work. -->

### Actual Behavior / Situation

### Please paste the results of `npx webpack info` here, and mention other relevant information
<!-- Describe how it currently works or behaves. -->

### Please paste the results of `npx webpack-cli info` here, and mention other relevant information.
14 changes: 11 additions & 3 deletions .github/ISSUE_TEMPLATE/SUPPORT.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,15 @@
---
name: 🆘 Support, Help, and Advice
about: 👉🏽 Need support, help, or advice? Don't open an issue! Head to https://github.com/webpack/webpack/discussions, StackOverflow or https://gitter.im/webpack/webpack.
about: 👉🏽 Need support, help, or advice? Don't open an issue - visit "GitHub Discussions" or "Stack Overflow" instead.
---

Hey there! If you need support, help, or advice then this is not the place to ask.
Please visit [GitHub Discussions](https://github.com/webpack/webpack/discussions) or [StackOverflow](https://stackoverflow.com/questions/tagged/webpack) instead.
Hey there! 👋

If you need support, help, or advice then this is not the right place to ask.

Please visit one of the following instead:

- [GitHub Discussions](https://github.com/webpack/webpack/discussions)
- [Stack Overflow](https://stackoverflow.com/questions/tagged/webpack)

Thanks for understanding!