Skip to content

Commit

Permalink
Update GitHub issue templates and workflows
Browse files Browse the repository at this point in the history
  • Loading branch information
1aron committed Feb 25, 2024
1 parent d7e66b4 commit 8bb81a6
Show file tree
Hide file tree
Showing 9 changed files with 68 additions and 43 deletions.
8 changes: 2 additions & 6 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
Expand Up @@ -23,11 +23,9 @@ body:
label: Reproduction
description: Please provide a step-by-step [minimal reproduction](https://stackoverflow.com/help/minimal-reproducible-example) of the bug. It helps us to efficiently track down the bug.
placeholder: |
1. ...
2. ...
1. ...
2. ...
3. ...
validations:
required: false
- type: textarea
id: system
Expand All @@ -39,8 +37,6 @@ body:
OS: macOS 12.0.1 (amd64)
Node.js: 16.31.1
Package Manager: pnpm 6.32.3
validations:
required: true
- type: markdown
attributes:
Expand Down
31 changes: 13 additions & 18 deletions .github/ISSUE_TEMPLATE/docs_request.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,21 +4,16 @@ title: '📄 '
labels: [documentation]

body:
- type: textarea
attributes:
label: What is the improvement or update you wish to see?
description: 'Example: I would like to see more examples of how to use the xxx. Or, the xxx docs are missing information.'
validations:
required: true
- type: textarea
attributes:
label: Is there any context that might help us understand?
description: A clear description of any added context that might help us understand.
validations:
required: true
- type: input
attributes:
label: Does the docs page already exist? Please link to it.
placeholder: https://
validations:
required: false
- type: textarea
attributes:
label: What is the improvement or update you wish to see?
description: 'Example: I would like to see more examples of how to use the xxx. Or, the xxx docs are missing information.'
validations:
required: true

- type: input
attributes:
label: Does the docs page already exist? Please link to it.
placeholder: https://
validations:
required: false
28 changes: 14 additions & 14 deletions .github/ISSUE_TEMPLATE/feature_request.yml
Original file line number Diff line number Diff line change
@@ -1,19 +1,19 @@
name: "✨ Feature"
name: '✨ Feature'
description: Propose a new feature
title: ''
labels: [enhancement]
labels: [feature]

body:
- type: markdown
attributes:
value: Have a great idea for a new feature? Let us know!
- type: markdown
attributes:
value: Have a great idea for a new feature? Let us know!

- type: textarea
id: description
attributes:
label: Description
description: |
Please tell us what you want to see in the next release and why you want to see it.
If you are going to make a pull request, please let us know your scheduling.
validations:
required: true
- type: textarea
id: description
attributes:
label: Description
description: |
Please tell us what you want to see in the next release and why you want to see it.
If you are going to make a pull request, please let us know your scheduling.
validations:
required: true
34 changes: 34 additions & 0 deletions .github/ISSUE_TEMPLATE/improvement_request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
name: '💖 Improvement'
description: Propose improvements to existing functionality or architecture.
title: '💖 '
labels: [improvement]

body:
- type: markdown
attributes:
value: Tell us about anything that needs improvement or enhancement!

- type: textarea
id: context
attributes:
label: Context
description: |
Describe the current and expected common context.
- type: textarea
id: current
attributes:
label: Current
description: |
Please describe the current issues that need to be improved.
validations:
required: true

- type: textarea
id: expected
attributes:
label: Expected
description: |
Please describe what you expect the improvements to look like.
validations:
required: true
2 changes: 1 addition & 1 deletion .github/workflows/commit-check.yml
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ jobs:
- uses: actions/checkout@v4
with:
fetch-depth: 0
- uses: pnpm/action-setup@v2
- uses: pnpm/action-setup@v3
with:
version: 8
- uses: actions/setup-node@v4
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/lint.yml
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ jobs:
os: [ubuntu-latest]
steps:
- uses: actions/checkout@v4
- uses: pnpm/action-setup@v2
- uses: pnpm/action-setup@v3
with:
version: 8
- uses: actions/setup-node@v4
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/release.yml
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ jobs:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: pnpm/action-setup@v2
- uses: pnpm/action-setup@v3
with:
version: 8
- uses: actions/setup-node@v4
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/test.yml
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ jobs:
os: [ubuntu-latest, windows-latest]
steps:
- uses: actions/checkout@v4
- uses: pnpm/action-setup@v2
- uses: pnpm/action-setup@v3
with:
version: 8
- uses: actions/setup-node@v4
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/type-check.yml
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ jobs:
os: [ubuntu-latest]
steps:
- uses: actions/checkout@v4
- uses: pnpm/action-setup@v2
- uses: pnpm/action-setup@v3
with:
version: 8
- uses: actions/setup-node@v4
Expand Down

0 comments on commit 8bb81a6

Please sign in to comment.