Skip to content

Commit a741573

Browse files
unicornwareunicornware
committed
chore(github): convert issue templates to issue forms
- https://docs.github.com/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-issue-forms - https://docs.github.com/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-githubs-form-schema Signed-off-by: Lexus Drumgold <unicornware@flexdevelopment.llc>
1 parent f9b6530 commit a741573

File tree

10 files changed

+260
-147
lines changed

10 files changed

+260
-147
lines changed

‎.eslintrc.base.cjs‎

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1047,6 +1047,39 @@ const config = {
10471047
'unicorn/string-content': 0
10481048
}
10491049
},
1050+
{
1051+
files: ['.github/ISSUE_TEMPLATE/*.yml'],
1052+
overrides: [
1053+
{
1054+
files: ['.github/ISSUE_TEMPLATE/config.yml'],
1055+
rules: {
1056+
'yml/sort-keys': [
1057+
2,
1058+
{
1059+
order: { caseSensitive: true, type: 'asc' },
1060+
pathPattern: '^$'
1061+
}
1062+
]
1063+
}
1064+
}
1065+
],
1066+
rules: {
1067+
'yml/sort-keys': [
1068+
2,
1069+
{
1070+
order: [
1071+
'name',
1072+
'description',
1073+
'title',
1074+
'assignees',
1075+
'labels',
1076+
'body'
1077+
],
1078+
pathPattern: '^$'
1079+
}
1080+
]
1081+
}
1082+
},
10501083
{
10511084
files: ['.github/dependabot.yml', '.github/workflows/*.yml'],
10521085
rules: {

‎.github/ISSUE_TEMPLATE/bug.md‎

Lines changed: 0 additions & 56 deletions
This file was deleted.

‎.github/ISSUE_TEMPLATE/bug.yml‎

Lines changed: 86 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,86 @@
1+
name: Bug report
2+
description: Something isn't working
3+
title: 🐛 <title>
4+
labels:
5+
- status:needs-triage
6+
- type:fix
7+
body:
8+
- type: markdown
9+
attributes:
10+
value: |
11+
Thank you for reporting the issue you are facing.
12+
Complete the form below to ensure the necessary details are captured to assist you.
13+
- id: prerequisites
14+
type: checkboxes
15+
attributes:
16+
label: Prerequisites
17+
options:
18+
- label: read documentation
19+
required: true
20+
- label: searched open issues for existing bug report
21+
required: true
22+
- label: searched closed issues for solution(s) or feedback
23+
required: true
24+
- id: current-behavior
25+
type: textarea
26+
attributes:
27+
label: Current behavior
28+
description: A concise description of what you're experiencing
29+
validations:
30+
required: true
31+
- id: repro
32+
type: textarea
33+
attributes:
34+
label: Reproduction
35+
description: |
36+
[Minimal, reproducible example](https://stackoverflow.com/help/minimal-reproducible-example)
37+
validations:
38+
required: true
39+
- id: expected-behavior
40+
type: textarea
41+
attributes:
42+
label: Expected behavior
43+
description: A concise description of what you expected to happen
44+
validations:
45+
required: true
46+
- id: version
47+
type: input
48+
attributes:
49+
label: Package version
50+
description: Version identified from `npm info <package-name>` or `yarn info <package-name>`
51+
validations:
52+
required: true
53+
- id: node-version
54+
type: input
55+
attributes:
56+
label: Node.js version
57+
description: Output of `node --version`
58+
validations:
59+
required: true
60+
- id: package-manager
61+
type: input
62+
attributes:
63+
label: Package manager version
64+
description: Output of `npm --version` or `yarn --version`
65+
validations:
66+
required: true
67+
- id: os
68+
type: dropdown
69+
attributes:
70+
label: Operating system (environment)
71+
description: Provide the operating system that you are using
72+
options:
73+
- linux
74+
- macos
75+
- other
76+
- windows
77+
validations:
78+
required: true
79+
- id: additional-context
80+
type: textarea
81+
attributes:
82+
label: Additional context
83+
description: |
84+
Add any other details about the problem here. Include links as necessary (e.g. relevant docs, issues, pull requests, etc)
85+
validations:
86+
required: false

‎.github/ISSUE_TEMPLATE/config.yml‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,9 @@ contact_links:
77
- name: Discuss an idea
88
url: https://github.com/flex-development/tutils/discussions/new?category=ideas
99
about: Discuss an idea before submitting a feature request
10+
- name: Q&A
11+
url: https://github.com/flex-development/tutils/discussions/new?category=q-a
12+
about: Ask and answer questions
1013
- name: Show and tell
1114
url: https://github.com/flex-development/tutils/discussions/new?category=show-and-tell
1215
about: Show the community how you integrated this project into yours

‎.github/ISSUE_TEMPLATE/feature.md‎

Lines changed: 0 additions & 25 deletions
This file was deleted.

‎.github/ISSUE_TEMPLATE/feature.yml‎

Lines changed: 62 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,62 @@
1+
name: Feature
2+
description: Suggest new feature or improvement
3+
title: 👀 <title>
4+
labels:
5+
- type:feat
6+
- status:needs-triage
7+
body:
8+
- type: markdown
9+
attributes:
10+
value: |
11+
Thank you for submitting a suggestion.
12+
Complete the form below to ensure the necessary details are captured to provide a response.
13+
- id: desired-behavior
14+
type: textarea
15+
attributes:
16+
label: 💡 Idea
17+
description: A concise description of the desired behavior
18+
validations:
19+
required: true
20+
- id: linked-issue
21+
type: input
22+
attributes:
23+
label: Linked issue
24+
description: Is this related to an existing issue?
25+
placeholder: '#1'
26+
validations:
27+
required: false
28+
- id: frequency
29+
type: dropdown
30+
attributes:
31+
label: Usage frequency
32+
description: How often would this feature or improvement be used?
33+
options:
34+
- biweekly
35+
- daily
36+
- monthly
37+
- quarterly
38+
- weekly
39+
- yearly
40+
validations:
41+
required: true
42+
- id: context
43+
type: textarea
44+
attributes:
45+
label: How does this tie into our current product?
46+
description: |
47+
Is this request related to an existing workflow, feature, or something else in the product? Or, does this open the project up to new ideas?
48+
validations:
49+
required: true
50+
- id: scale
51+
type: dropdown
52+
attributes:
53+
label: Difficulty scale
54+
description: Filled out post-triage by a maintainer
55+
options:
56+
- '1'
57+
- '2'
58+
- '3'
59+
- '4'
60+
- '5'
61+
validations:
62+
required: false

‎.github/ISSUE_TEMPLATE/question.md‎

Lines changed: 0 additions & 21 deletions
This file was deleted.

‎.github/ISSUE_TEMPLATE/task.md‎

Lines changed: 0 additions & 30 deletions
This file was deleted.

‎.github/ISSUE_TEMPLATE/task.yml‎

Lines changed: 57 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
1+
name: Task
2+
description: Project task (maintainers only)
3+
title: 🔨 <title>
4+
labels:
5+
- type:task
6+
body:
7+
- id: prerequisites
8+
type: checkboxes
9+
attributes:
10+
label: Prerequisites
11+
options:
12+
- label: i am a project maintainer
13+
required: true
14+
- id: proposal
15+
type: textarea
16+
attributes:
17+
label: Proposed work
18+
description: High-level overview of what is being implemented
19+
validations:
20+
required: true
21+
- id: criteria
22+
type: textarea
23+
attributes:
24+
label: Success criteria
25+
description: Checklist containing the criteria that must be met to consider the task a success
26+
value: |
27+
- [ ]
28+
validations:
29+
required: true
30+
- id: related-documents
31+
type: textarea
32+
attributes:
33+
label: Related documents
34+
description: Relevant documentation, issues, proposals, technical specs, etc
35+
value: |
36+
-
37+
-
38+
-
39+
validations:
40+
required: false
41+
- id: additional-context
42+
type: textarea
43+
attributes:
44+
label: Additional context
45+
description: Add any other details about the task here
46+
validations:
47+
required: false
48+
- id: linked-issues
49+
type: textarea
50+
attributes:
51+
label: Linked issues
52+
description: Related issues and pull requests
53+
placeholder: |
54+
- #<issue-number>
55+
- resolves #<issue-number>
56+
validations:
57+
required: false

0 commit comments

Comments
 (0)