archive-gh-me/typeorm
1
0
Fork 0
mirror of https://github.com/typeorm/typeorm.git synced 2025-12-08 21:26:23 +00:00
Code Issues Projects Releases Wiki Activity

Github issue templates converted to forms (#9434)

Browse Source 
* Update and rename bug-report.md to bug-report.yml

* Update and rename documentation-issue.md to documentation-issue.yml

* Update and rename feature-request.md to feature-request.yml

* checkboxes

* Update feature-request.yml

* Update feature-request.yml

Co-authored-by: AlexMesser <dmzt08@gmail.com>
This commit is contained in:
Dominic Ruggiero 2022-12-03 06:55:37 -05:00 committed by GitHub
parent 975a953995
commit 68f18a36d9
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
6 changed files with 311 additions and 283 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

121
.github/ISSUE_TEMPLATE/bug-report.md vendored
View File

@ -1,121 +0,0 @@
---
name: "🐛 Bug Report"
about: Report a reproducible bug or regression.
title: ''
labels: requires triage, bug
assignees: ''
---
<!--
Please follow the template. If you don't, your issue may be closed.
Have a question? This is the TypeORM issue tracker - and not the right place
for general support or questions. Instead, check the "Support" Documentation
on the best places to ask questions!
https://github.com/typeorm/typeorm/blob/master/docs/support.md
-->
## Issue Description
### Expected Behavior
<!--
A clear and concise description of what you expected to happen.
-->
### Actual Behavior
<!--
A clear and concise description of what actually happened.
Please wrap any error messages or output in code tags, instead of images.
-->
```
// include the output in code tags like these!
```
### Steps to Reproduce
<!--
Your bug will be investigated much faster if we can run your code and it doesn't
have dependencies other than TypeORM. Issues without reproduction steps or
code examples may be closed as not actionable.
Please try to provide a Minimal, Complete, and Verifiable example.
http://stackoverflow.com/help/mcve
-->
1.
2.
```typescript
// insert code here
```
### My Environment
<!--
Please add any other relevant dependencies to this table at the end.
For example: Electron, React Native, or NestJS.
-->
| Dependency | Version |
| --- | --- |
| Operating System | |
| Node.js version | x.y.zzz | <!-- run `node -v` to obtain this -->
| Typescript version | x.y.zzz | <!-- run `npm list typescript` to obtain this -->
| TypeORM version | x.y.zzz | <!-- run `npm list typeorm` to obtain this -->
### Additional Context
<!--
Add any other context about the bug report here.
-->
### Relevant Database Driver(s)
<!-- Put "yes" instead of "no" to your issue's relevant databases -->
| DB Type | Reproducible |
|-------------------| --- |
| `aurora-mysql` | no |
| `aurora-postgres` | no |
| `better-sqlite3` | no |
| `cockroachdb` | no |
| `cordova` | no |
| `expo` | no |
| `mongodb` | no |
| `mysql` | no |
| `nativescript` | no |
| `oracle` | no |
| `postgres` | no |
| `react-native` | no |
| `sap` | no |
| `spanner` | no |
| `sqlite` | no |
| `sqlite-abstract` | no |
| `sqljs` | no |
| `sqlserver` | no |
### Are you willing to resolve this issue by submitting a Pull Request?
<!-- Put "✅" (:white_check_mark:) to one of these options, left "✖️" (:heavy_multiplication_x:) others: -->
- ✅ 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, but I can support (using donations) development.
- ✖️ No, I don’t have the time and I’m okay to wait for the community / maintainers to resolve this issue.
<!--
Remember that first-time contributors are welcome! 🙌
👋 Have a great day and thank you for the bug report!
-->

134
.github/ISSUE_TEMPLATE/bug-report.yml vendored Normal file
View File

@ -0,0 +1,134 @@
name: 🐛 Bug Report
description: Report a reproducible bug or regression.
title: "[BUG]: "
labels:
- requires triage
- bug
body:
- type: markdown
attributes:
value: |2-
Have a question? This is the TypeORM issue tracker – and not the right place for general support or questions. Instead, check the ["Support" Documentation]( https://github.com/typeorm/typeorm/blob/master/docs/support.md
) on the best places to ask questions!
- type: input
id: description
attributes:
label: Issue description
validations:
required: true
- type: textarea
id: expected
attributes:
label: Expected Behavior
description: " A clear and concise description of what you expected to happen."
validations:
required: true
- type: textarea
id: actual
attributes:
label: Actual Behavior
description: >-
A clear and concise description of what actually happened. Please wrap
any error messages or output in code tags, instead of images.
validations:
required: true
- type: textarea
id: steps
attributes:
label: Steps to reproduce
description: >-
Your bug will be investigated much faster if we can run your code and it
doesn't have dependencies other than TypeORM. Issues without
reproduction steps or code examples may be closed as not actionable.
placeholder: >-
Please try to provide a Minimal, Complete, and Verifiable example.
http://stackoverflow.com/help/mcve
validations:
required: true
- type: textarea
id: env
attributes:
label: My Environment
description: >-
Please add any other relevant dependencies to this table at the end. For
example: Electron, React Native, or NestJS.
value: |
| Dependency | Version |
| --- | --- |
| Operating System | |
| Node.js version | x.y.zzz |
| Typescript version | x.y.zzz |
| TypeORM version | x.y.zzz |
validations:
required: true
- type: textarea
id: context
attributes:
label: Additional Context
description: >-
Add any other context about the bug report here. Add any other context
about the bug report here.
- type: checkboxes
id: drivers
attributes:
label: Relevant Database Driver(s)
options:
- label: aurora-mysql
required: false
- label: aurora-postgres
required: false
- label: better-sqlite3
required: false
- label: cockroachdb
required: false
- label: cordova
required: false
- label: expo
required: false
- label: mongodb
required: false
- label: mysql
required: false
- label: nativescript
required: false
- label: oracle
required: false
- label: postgres
required: false
- label: react-native
required: false
- label: sap
required: false
- label: spanner
required: false
- label: sqlite
required: false
- label: sqlite-abstract
required: false
- label: sqljs
required: false
- label: sqlserver
required: false
- type: dropdown
id: pr
attributes:
label: Are you willing to resolve this issue by submitting a Pull Request?
options:
- 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, but I can support (using donations)
development.
- >-
No, I don’t have the time and I’m okay to wait for the community /
maintainers to resolve this issue.
validations:
required: true
- type: markdown
attributes:
value: |2-
Remember that first-time contributors are welcome! 🙌
👋 Have a great day and thank you for the bug report!

63
.github/ISSUE_TEMPLATE/documentation-issue.md vendored
View File

@ -1,63 +0,0 @@
---
name: 📝 Documentation Issue
about: Documentation is unclear or otherwise insufficient.
title: ''
labels: documentation, requires triage
assignees: ''
---
<!--
Please follow the template. If you don't, your issue may be closed.
Have a question? This is the TypeORM issue tracker - and not the right place
for general support or questions. Instead, check the "Support" Documentation
on the best places to ask questions!
https://github.com/typeorm/typeorm/blob/master/docs/support.md
-->
## Documentation Issue
### What was unclear or otherwise insufficient?
<!--
If relevant, Please be clear about the documentation file,
as well as the location within the file. Link to the documentation
in the repository.
If the page does not exist, please be clear why a new documentation
section is needed.
-->
### Recommended Fix
<!--
How should we fix this documentation issue?
Should we add examples, clarify the language, or drop the page entirely?
-->
### Additional Context
<!--
Add any other context about the documentation issue here.
-->
### Are you willing to resolve this issue by submitting a Pull Request?
<!-- Put "✅" (:white_check_mark:) to one of these options, left "✖️" (:heavy_multiplication_x:) others: -->
- ✅ 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, but I can support (using donations) development.
- ✖️ No, I don’t have the time and I’m okay to wait for the community / maintainers to resolve this issue.
<!--
Remember that first-time contributors are welcome! 🙌
👋 Have a great day and thank you for the documentation problem report!
-->

64
.github/ISSUE_TEMPLATE/documentation-issue.yml vendored Normal file
View File

@ -0,0 +1,64 @@
name: 📝 Documentation Issue
description: Documentation is unclear or otherwise insufficient.
title: "[DOCS]: "
labels:
- documentation
- requires triage
body:
- type: markdown
attributes:
value: >-
Have a question? This is the TypeORM issue tracker - and not the right
place for general support or questions. Instead, check the [“Support"
Documentation](https://github.com/typeorm/typeorm/blob/master/docs/support.md
) on the best places to ask questions!
- type: textarea
id: details
attributes:
label: What was unclear or otherwise insufficient?
description: >-
If relevant, Please be clear about the documentation file, as well as
the location within the file. Link to the documentation in the
repository.
placeholder: >-
If the page does not exist, please be clear why a new documentation
section is needed.
validations:
required: true
- type: textarea
id: recommendation
attributes:
label: Recommended Fix
description: How should we fix this documentation issue?
placeholder: Should we add examples, clarify the language, or drop the page entirely?
validations:
required: true
- type: textarea
id: context
attributes:
label: Additional Context
description: Add any other context about the documentation issue here.
- type: dropdown
id: pr
attributes:
label: Are you willing to resolve this issue by submitting a Pull Request?
options:
- 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, but I can support (using donations)
development.
- >-
No, I don’t have the time and I’m okay to wait for the community /
maintainers to resolve this issue.
validations:
required: true
- type: markdown
attributes:
value: |-
Remember that first-time contributors are welcome! 🙌
👋 Have a great day and thank you for the documentation problem report!

99
.github/ISSUE_TEMPLATE/feature-request.md vendored
View File

@ -1,99 +0,0 @@
---
name: 🌈 Feature request
about: Suggest an amazing new idea for this project
title: ''
labels: new feature, requires triage
assignees: ''
---
<!--
Please follow the template. If you don't, your issue may be closed.
Have a question? This is the TypeORM issue tracker - and not the right place
for general support or questions. Instead, check the "Support" Documentation
on the best places to ask questions!
https://github.com/typeorm/typeorm/blob/master/docs/support.md
-->
## Feature Description
### The Problem
<!--
A clear and concise description of what the problem is, and
why it needs to be implemented as a new feature for TypeORM.
For example, "I'm always frustrated when ..."
Why should this be a part of TypeORM?
-->
### The Solution
<!--
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?
-->
### Considered Alternatives
<!--
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
<!--
Add any other context about the feature request here.
-->
### Relevant Database Driver(s)
<!-- Put "yes" instead of "no" to your issue's relevant databases -->
| DB Type | Relevant |
|-------------------| --- |
| `aurora-mysql` | no |
| `aurora-postgres` | no |
| `better-sqlite3` | no |
| `cockroachdb` | no |
| `cordova` | no |
| `expo` | no |
| `mongodb` | no |
| `mysql` | no |
| `nativescript` | no |
| `oracle` | no |
| `postgres` | no |
| `react-native` | no |
| `sap` | no |
| `spanner` | no |
| `sqlite` | no |
| `sqlite-abstract` | no |
| `sqljs` | no |
| `sqlserver` | no |
### Are you willing to resolve this issue by submitting a Pull Request?
<!-- Put "✅" (:white_check_mark:) to one of these options, left "✖️" (:heavy_multiplication_x:) others: -->
- ✅ 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, but I can support (using donations) development.
- ✖️ No, I don’t have the time and I’m okay to wait for the community / maintainers to resolve this issue.
<!--
Remember that first-time contributors are welcome! 🙌
👋 Have a great day and thank you for the feature request!
-->

113
.github/ISSUE_TEMPLATE/feature-request.yml vendored Normal file
View File

@ -0,0 +1,113 @@
name: 🌈 Feature request
description: Suggest an amazing new idea for this project
title: "[FEATURE]:"
labels:
- new feature
- requires triage
body:
- type: markdown
attributes:
value: >-
Have a question? This is the TypeORM issue tracker - and not the right
place for general support or questions. Instead, check the [“Support"
Documentation](https://github.com/typeorm/typeorm/blob/master/docs/support.md)
on the best places to ask questions!
- type: textarea
id: problem
attributes:
label: Feature Description
description: >-
A clear and concise description of what the problem is, and why it needs
to be implemented as a new feature for TypeORM.
placeholder: For example, "I'm always frustrated when ..."
validations:
required: true
- type: textarea
id: solution
attributes:
label: The Solution
description: A clear and concise description of what you want to happen.
placeholder: >-
How can the requested feature be used to approach the problem it's
supposed to solve?
validations:
required: true
- type: textarea
id: alt
attributes:
label: Considered Alternatives
description: >-
A clear and concise description of any alternative solutions or features
you've considered.
placeholder: If any workaround exists to the best of your knowledge, include it here.
validations:
required: true
- type: textarea
id: context
attributes:
label: Additional Context
description: Add any other context about the feature request here
- type: checkboxes
id: drivers
attributes:
label: Relevant Database Driver(s)
options:
- label: aurora-mysql
required: false
- label: aurora-postgres
required: false
- label: better-sqlite3
required: false
- label: cockroachdb
required: false
- label: cordova
required: false
- label: expo
required: false
- label: mongodb
required: false
- label: mysql
required: false
- label: nativescript
required: false
- label: oracle
required: false
- label: postgres
required: false
- label: react-native
required: false
- label: sap
required: false
- label: spanner
required: false
- label: sqlite
required: false
- label: sqlite-abstract
required: false
- label: sqljs
required: false
- label: sqlserver
required: false
- type: dropdown
id: pr
attributes:
label: Are you willing to resolve this issue by submitting a Pull Request?
options:
- 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, but I can support (using donations)
development.
- >-
No, I don’t have the time and I’m okay to wait for the community /
maintainers to resolve this issue.
validations:
required: true
- type: markdown
attributes:
value: |-
Remember that first-time contributors are welcome! 🙌
👋 Have a great day and thank you for the feature request!