Skip to content

Commit 23061db

Browse files
committed
Convert to using GitHub forms for issue templates
1 parent f87fc52 commit 23061db

File tree

4 files changed

+161
-135
lines changed

4 files changed

+161
-135
lines changed

.github/ISSUE_TEMPLATE/bug_report.md

Lines changed: 0 additions & 90 deletions
This file was deleted.
Lines changed: 100 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,100 @@
1+
#/
2+
# @license Apache-2.0
3+
#
4+
# Copyright (c) 2021 The Stdlib Authors.
5+
#
6+
# Licensed under the Apache License, Version 2.0 (the "License");
7+
# you may not use this file except in compliance with the License.
8+
# You may obtain a copy of the License at
9+
#
10+
# http://www.apache.org/licenses/LICENSE-2.0
11+
#
12+
# Unless required by applicable law or agreed to in writing, software
13+
# distributed under the License is distributed on an "AS IS" BASIS,
14+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15+
# See the License for the specific language governing permissions and
16+
# limitations under the License.
17+
#/
18+
19+
name: 🐛 Bug Report
20+
description: Something isn't working as I expected. 🤔
21+
labels: [bug]
22+
body:
23+
- type: textarea
24+
id: description
25+
attributes:
26+
label: Description
27+
description: Description of the issue.
28+
value: "Encountered an error when "
29+
validations:
30+
required: true
31+
- type: textarea
32+
id: related
33+
attributes:
34+
label: Related Issues
35+
description: Does this issue have any related issues?
36+
value: "Related issues # , # , and # ."
37+
- type: textarea
38+
id: questions
39+
attributes:
40+
label: Questions
41+
description: Any questions for reviewers?
42+
value: No.
43+
- type: input
44+
id: demo
45+
attributes:
46+
label: Demo
47+
description: If relevant, provide a link to a live demo.
48+
placeholder: For a live demo of the issue, see
49+
validations:
50+
required: false
51+
- type: textarea
52+
id: reproduction
53+
attributes:
54+
label: Reproduction
55+
description: What steps are required to reproduce the unexpected output?
56+
value: |
57+
- a
58+
- b
59+
- c
60+
render: shell
61+
- type: textarea
62+
id: expected
63+
attributes:
64+
label: Expected Results
65+
description: What are the expected results?
66+
placeholder: Insert expected results here
67+
render: shell
68+
- type: textarea
69+
id: actual
70+
attributes:
71+
label: Actual Results
72+
description: What are the actual results?
73+
placeholder: Insert actual results here
74+
render: shell
75+
- type: input
76+
id: version
77+
attributes:
78+
label: Version
79+
description: What version of `stdlib` are you running?
80+
- type: textarea
81+
id: environments
82+
attributes:
83+
label: Environments
84+
description: What environments are affected (e.g., `Node v0.4.x`, `Chrome`, `IE 11`)? If Node.js, include the `npm` version, operating system, and any other potentially relevant platform information.
85+
value: |
86+
The following environments are affected:
87+
88+
- a
89+
- b
90+
- c
91+
- type: checkboxes
92+
id: checklist
93+
attributes:
94+
label: Checklist
95+
description: Please ensure the following tasks are completed before filing a bug report.
96+
options:
97+
- label: Read and understood the [Code of Conduct](https://github.com/stdlib-js/stdlib/blob/develop/CODE_OF_CONDUCT.md).
98+
required: true
99+
- label: Searched for existing issues and pull requests.
100+
required: true

.github/ISSUE_TEMPLATE/feature_request.md

Lines changed: 0 additions & 45 deletions
This file was deleted.
Lines changed: 61 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,61 @@
1+
#/
2+
# @license Apache-2.0
3+
#
4+
# Copyright (c) 2021 The Stdlib Authors.
5+
#
6+
# Licensed under the Apache License, Version 2.0 (the "License");
7+
# you may not use this file except in compliance with the License.
8+
# You may obtain a copy of the License at
9+
#
10+
# http://www.apache.org/licenses/LICENSE-2.0
11+
#
12+
# Unless required by applicable law or agreed to in writing, software
13+
# distributed under the License is distributed on an "AS IS" BASIS,
14+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15+
# See the License for the specific language governing permissions and
16+
# limitations under the License.
17+
#/
18+
19+
name: 🚀 Feature Request
20+
description: I have a suggestion (and may want to help contribute 🙂)!
21+
title: "[RFC]: "
22+
labels: [rfc, feature]
23+
body:
24+
- type: textarea
25+
id: description
26+
attributes:
27+
label: Description
28+
description: Description of the feature request.
29+
value: This RFC proposes
30+
validations:
31+
required: true
32+
- type: textarea
33+
id: related
34+
attributes:
35+
label: Related Issues
36+
description: Does this feature request have any related issues?
37+
value: "Related issues # , # , and # ."
38+
- type: textarea
39+
id: questions
40+
attributes:
41+
label: Questions
42+
description: Any questions for reviewers?
43+
value: No.
44+
- type: textarea
45+
id: other
46+
attributes:
47+
label: Other
48+
description: Any other information relevant to this feature request? This may include screenshots, references, sample output, and/or implementation notes.
49+
value: No.
50+
- type: checkboxes
51+
id: checklist
52+
attributes:
53+
label: Checklist
54+
description: Please ensure the following tasks are completed before submitting a feature request.
55+
options:
56+
- label: I have read and understood the [Code of Conduct](https://github.com/stdlib-js/stdlib/blob/develop/CODE_OF_CONDUCT.md).
57+
required: true
58+
- label: Searched for existing issues and pull requests.
59+
required: true
60+
- label: The issue name begins with `RFC:`.
61+
required: true

0 commit comments

Comments
 (0)