不要怂,就是干,撸起袖子干!

Commit 1bf032dd by Pedro Augusto de Paula Barbosa Committed by Sushant

chore(.github): improve issue templates (#11334)

1 parent b72e3bb2
--- ---
name: Bug report name: Bug report
about: Create a report to help us improve about: Create a bug report to help us improve
title: '' title: ''
labels: '' labels: ''
assignees: '' assignees: ''
...@@ -8,43 +8,67 @@ assignees: '' ...@@ -8,43 +8,67 @@ assignees: ''
--- ---
<!-- <!--
If you don't follow the issue template, your issue may be closed.
Please note this is an issue tracker, not a support forum. Please note this is an issue tracker, not a support forum.
For general questions, please use StackOverflow or Slack. For general questions, please use StackOverflow or Slack.
--> -->
## What are you doing? ## Issue Description
<!-- Post a minimal, self-contained code sample that reproduces the issue, including models and associations -->
### What are you doing?
<!--
Post a MINIMAL, SELF-CONTAINED code that reproduces the issue. It must be runnable by simply copying and pasting into an isolated JS file, except possibly for the database connection configuration.
Check http://sscce.org/ or https://stackoverflow.com/help/minimal-reproducible-example to learn more about SSCCE/MCVE/reprex.
-->
```js ```js
// code here // MINIMAL, SELF-CONTAINED code here (SSCCE/MCVE/reprex)
``` ```
**To Reproduce**
Steps to reproduce the behavior:
1. Define models X, Y, ...
2. Run the following
3. See error
## What do you expect to happen? ### What do you expect to happen?
<!-- Explain what behavior you wanted/expected. You may include an output. -->
_I wanted Foo!_ _I wanted Foo!_
## What is actually happening? ### What is actually happening?
_But the output was bar!_
<!-- Show what happened. -->
_Output, either JSON or SQL_
_The output was Bar!_
## Environment
Dialect: ```
- [ ] mysql Output here
- [ ] postgres ```
- [ ] sqlite
- [ ] mssql ### Additional context
- [ ] any Add any other context or screenshots about the feature request here.
Dialect **library** version: XXX
Database version: XXX ### Environment
Sequelize version: XXX
Node Version: XXX - Sequelize version: XXX <!-- run `npm list sequelize` to obtain this -->
OS: XXX - Node.js version: XXX <!-- run `node -v` to obtain this -->
If TypeScript related: TypeScript version: XXX - Operating System: XXX
Tested with latest release: - If TypeScript related: TypeScript version: XXX
- [ ] No
- [ ] Yes, specify that version: ## Issue Template Checklist
<!-- Please answer the questions below. If you don't, your issue may be closed. -->
### How does this problem relate to dialects?
<!-- Choose one. -->
- [ ] I think this problem happens regardless of the dialect.
- [ ] I think this problem happens only for the following dialect(s): <!-- Put dialect(s) here -->
- [ ] I don't know, I was using PUT-YOUR-DIALECT-HERE, with connector library version XXX and database version XXX
### Would you be willing to resolve this issue by submitting a Pull Request?
<!-- Remember that first contributors are welcome! -->
- [ ] Yes, I have the time and I know how to start.
- [ ] Yes, I have the time but I don't know how to start, I would need guidance.
- [ ] No, I don't have the time, although I believe I could do it if I had the time...
- [ ] No, I don't have the time and I wouldn't even know how to start.
--- ---
name: Documentational issue name: Docs issue
about: Documentation is unclear, or otherwise insufficient/misleading about: Documentation is unclear, or otherwise insufficient/misleading
title: '' title: ''
labels: documentation labels: 'type: docs'
assignees: '' assignees: ''
--- ---
## What was unclear/insufficient/not covered in the documentation <!--
If you don't follow the issue template, your issue may be closed.
Please note this is an issue tracker, not a support forum.
For general questions, please use StackOverflow or Slack.
-->
## Issue Description
### What was unclear/insufficient/not covered in the documentation
Write here.
### If possible: Provide some suggestion on how we can enhance the docs
Write here.
### Additional context
Add any other context or screenshots about the issue here.
## Issue Template Checklist
<!-- Please answer the questions below. If you don't, your issue may be closed. -->
### Is this issue dialect-specific?
- [ ] No. This issue is relevant to Sequelize as a whole.
- [ ] Yes. This issue only applies to the following dialect(s): XXX, YYY, ZZZ
- [ ] I don't know.
### Would you be willing to resolve this issue by submitting a Pull Request?
<!-- Remember that first contributors are welcome! -->
- [ ] Yes, I have the time and I know how to start.
- [ ] Yes, I have the time but I don't know how to start, I would need guidance.
- [ ] No, I don't have the time, although I believe I could do it if I had the time...
- [ ] No, I don't have the time and I wouldn't even know how to start.
### If possible: Provide some suggestion how we can enhance the docs
> Text goes here
...@@ -2,25 +2,52 @@ ...@@ -2,25 +2,52 @@
name: Feature request name: Feature request
about: Suggest an idea for this project about: Suggest an idea for this project
title: '' title: ''
labels: feature labels: ''
assignees: '' assignees: ''
--- ---
**Is your feature request related to a problem? Please describe.** <!--
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] If you don't follow the issue template, your issue may be closed.
Please note this is an issue tracker, not a support forum.
For general questions, please use StackOverflow or Slack.
-->
**Describe the solution you'd like** ## Issue Description
A clear and concise description of what you want to happen.
**Why should this be in Sequelize** ### Is your feature request related to a problem? Please describe.
Short explanation why this should be part of Sequelize rather than a separate package. A clear and concise description of what the problem is. Example: I'm always frustrated when [...]
### Describe the solution you'd like
A clear and concise description of what you want to happen. How can the requested feature be used to approach the problem it's supposed to solve?
```js
// If applicable, add a code snippet showing how your feature would be used in a real use-case
```
**Describe alternatives you've considered** ### Why should this be in Sequelize
A clear and concise description of any alternative solutions or features you've considered. Short explanation why this should be part of Sequelize rather than a separate package.
**Usage example** ### Describe alternatives/workarounds you've considered
How can the requested feature be used to approach the problem it's supposed to solve. A clear and concise description of any alternative solutions or features you've considered. If any workaround exists to the best of your knowledge, include it here.
**Additional context** ### Additional context
Add any other context or screenshots about the feature request here. Add any other context or screenshots about the feature request here.
## Issue Template Checklist
<!-- Please answer the questions below. If you don't, your issue may be closed. -->
### Is this issue dialect-specific?
- [ ] No. This issue is relevant to Sequelize as a whole.
- [ ] Yes. This issue only applies to the following dialect(s): XXX, YYY, ZZZ
### Would you be willing to resolve this issue by submitting a Pull Request?
<!-- Remember that first contributors are welcome! -->
- [ ] Yes, I have the time and I know how to start.
- [ ] Yes, I have the time but I don't know how to start, I would need guidance.
- [ ] No, I don't have the time, although I believe I could do it if I had the time...
- [ ] No, I don't have the time and I wouldn't even know how to start.
---
name: Other
about: Open an issue that does not fall directly into the other categories
title: ''
labels: ''
assignees: ''
---
<!--
If you don't follow the issue template, your issue may be closed.
Please note this is an issue tracker, not a support forum.
For general questions, please use StackOverflow or Slack.
-->
## Issue Description
A clear and concise description of what is this issue about.
If applicable, you can add some code. In this case, an SSCCE/MCVE/reprex is much better than just an isolated code snippet.
<!--
Check http://sscce.org/ or https://stackoverflow.com/help/minimal-reproducible-example to learn more about SSCCE/MCVE/reprex.
-->
### StackOverflow / Slack attempts
If you have tried asking on StackOverflow / Slack about this, add a link to that here.
### Additional context
Add any other context or screenshots about the issue here.
## Issue Template Checklist
<!-- Please answer the questions below. If you don't, your issue may be closed. -->
### Is this issue dialect-specific?
- [ ] No. This issue is relevant to Sequelize as a whole.
- [ ] Yes. This issue only applies to the following dialect(s): XXX, YYY, ZZZ
- [ ] I don't know.
### Would you be willing to resolve this issue by submitting a Pull Request?
<!-- Remember that first contributors are welcome! -->
- [ ] Yes, I have the time and I know how to start.
- [ ] Yes, I have the time but I don't know how to start, I would need guidance.
- [ ] No, I don't have the time, although I believe I could do it if I had the time...
- [ ] No, I don't have the time and I wouldn't even know how to start.
Markdown is supported
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!