Skip to content

Commit

Permalink
docs: update github issues templates
Browse files Browse the repository at this point in the history
  • Loading branch information
Romakita committed Sep 4, 2023
1 parent 1b04627 commit e2c9c11
Show file tree
Hide file tree
Showing 4 changed files with 129 additions and 2 deletions.
88 changes: 88 additions & 0 deletions .github/ISSUE_TEMPLATE/01_bug-report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,88 @@
name: "\U0001F41B Bug report"
description: Create a report to help us improve
title: "[BUG] Title"
labels: [":bug: bug"]
assignees: ["Romakita"]
body:
- type: markdown
attributes:
value: |
Thanks for taking the time to fill out this bug report!
---
> **IMPORTANT: Before opening issue**
>
> - Please update all of your packages. I won't investigate on the issue if you are on an old version.
> - Please check that you have the same version for all Ts.ED dependencies (expected the logger). Many issues are related to a misconfigured packages.
> - Please provide a reproducible example (avoid screenshot, prefer copy/pasted code). The stack trace isn't enough to investigate.
>
> If these requirements aren't checked, I WON'T INVESTIGATE (excepted if you are a premium sponsors!) and issue will be closed!
---
- type: textarea
id: what-happened
attributes:
label: Describe the bug
description: A clear and concise description of what the bug is.
placeholder: Tell us what you see!
validations:
required: true
- type: textarea
id: repro-steps
attributes:
label: To Reproduce
description: Steps to reproduce the behavior
placeholder: |
1. Fetch a '...'
2. Update the '....'
3. See error
validations:
required: true
- type: textarea
id: expected-behavior
attributes:
label: Expected behavior
description: A clear and concise description of what you expected to happen.
validations:
required: true
- type: textarea
id: code-snippets
attributes:
label: Code snippets
description: If applicable, add code snippets to help explain your problem.
render: TypeScript
validations:
required: false
- type: input
id: repositoryUrl
attributes:
label: Repository URL example
placeholder: https://github.com/your/repository
- type: input
id: os
attributes:
label: OS
placeholder: macOS
validations:
required: true
- type: input
id: language-version
attributes:
label: Node version
placeholder: Node v18.17.1
validations:
required: true
- type: input
id: lib-version
attributes:
label: Library version
placeholder: v7.34.7
validations:
required: true
- type: textarea
id: additional-context
attributes:
label: Additional context
description: Add any other context about the problem here.
validations:
required: false
39 changes: 39 additions & 0 deletions .github/ISSUE_TEMPLATE/02_feature-request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
name: "\U0001F680 Feature request"
description: Suggest an idea for this library
labels: [":sparkles: enhancement"]
assignees: ["Romakita"]
body:
- type: markdown
attributes:
value: |
- All request features / PR are welcome!
- Thanks for taking the time to fill out this feature request!
- The Ts.ED team will works on the requested feature if:
- The community vote massively for it.
- The you are a premium sponsors (individual or company sponsors).
- type: textarea
id: problem
attributes:
label: Is your feature request related to a problem? Please describe.
description: A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
- type: textarea
id: solution
attributes:
label: Describe the solution you'd like
description: A clear and concise description of what you want to happen.
- type: textarea
id: alternatives
attributes:
label: Describe alternatives you've considered
description: A clear and concise description of any alternative solutions or features you've considered.
- type: textarea
id: context
attributes:
label: Additional context
description: Add any other context about the feature request here.
- type: textarea
id: context
attributes:
label: Acceptance criteria
description: Add acceptance criteria here.
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ assignees: Romakita
- Please check that you have the same version for all Ts.ED dependencies (expected the logger). Many issues are related to a misconfigured packages.
- Please provide a reproducible example (avoid screenshot, prefer copy/pasted code). The stack trace isn't enough to investigate.
If theses requirements aren't checked, I WON'T INVESTIGATE (excepted if you are a PREMIUM SPONSORS!) and issue will be CLOSED!
If these requirements aren't checked, I WON'T INVESTIGATE (excepted if you are a PREMIUM SPONSORS!) and issue will be CLOSED!
-->

## Information
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ labels: ":sparkles: enhancement"
assignees: Romakita
---

<!--
<!--
/!\ IMPORTANT
Expand Down

0 comments on commit e2c9c11

Please sign in to comment.