Skip to content

Commit fa618ae

Browse files
karimbahgatkarimbahgat
committed
Add issue templates
1 parent d1d66c6 commit fa618ae

File tree

5 files changed

+136
-0
lines changed

5 files changed

+136
-0
lines changed

‎.github/ISSUE_TEMPLATE/bug.yml‎

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
name: Bug Report
2+
description: Something in PyShp crashed and raised an exception.
3+
title: "Title goes here..."
4+
labels: ["bug"]
5+
body:
6+
- type: input
7+
id: pyshp-version
8+
attributes:
9+
label: PyShp Version
10+
description: Please input the version of PyShp you used. If unsure, call `shapefile.__version__`.
11+
placeholder: ...
12+
validations:
13+
required: true
14+
- type: input
15+
id: python-version
16+
attributes:
17+
label: Python Version
18+
description: Please input the version of the Python executable.
19+
placeholder: ...
20+
validations:
21+
required: true
22+
- type: textarea
23+
id: your-code
24+
attributes:
25+
label: Your code
26+
description: Please copy-paste the relevant parts of your code or script that triggered the error.
27+
placeholder: ...
28+
render: shell
29+
validations:
30+
required: true
31+
- type: textarea
32+
id: stacktrace
33+
attributes:
34+
label: Full stacktrace
35+
description: Please copy-paste the full stack trace of the exception that was raised.
36+
placeholder: ...
37+
render: shell
38+
validations:
39+
required: true
40+
- type: textarea
41+
id: notes
42+
attributes:
43+
label: Other notes
44+
description: Please input any other notes that may be relevant, e.g. do you have any thoughts on what might be wrong?
45+
placeholder: ...
46+
validations:
47+
required: false

‎.github/ISSUE_TEMPLATE/config.yml‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
blank_issues_enabled: true

‎.github/ISSUE_TEMPLATE/newfeature.yml‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
name: Feature Request
2+
description: You would like to request a new feature.
3+
title: "Title goes here..."
4+
labels: ["enhancement"]
5+
body:
6+
- type: textarea
7+
id: functionality
8+
attributes:
9+
label: Describe the feature request
10+
description: Please describe the functionality you would like added to PyShp.
11+
placeholder: ...
12+
validations:
13+
required: true
14+
- type: checkboxes
15+
id: contribute
16+
attributes:
17+
label: Willing to contribute?
18+
description: Would you be interested to contribute code that adds this functionality through a Pull Request? We gladly accept PRs - it's much faster and you'll be added a contributor.
19+
options:
20+
- label: I would like to add the described feature request through a PR.
21+
required: false

‎.github/ISSUE_TEMPLATE/question.yml‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
name: Question
2+
description: You have a question about PyShp or how to use it.
3+
title: "Title goes here..."
4+
labels: ["question"]
5+
body:
6+
- type: textarea
7+
id: question
8+
attributes:
9+
label: What's your question?
10+
description: Please describe what you would like to know about PyShp, e.g. how to do something.
11+
placeholder: ...
12+
validations:
13+
required: true

‎.github/ISSUE_TEMPLATE/unexpected.yml‎

Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
1+
name: Unexpected Behavior
2+
description: You think PyShp might be doing something wrong.
3+
title: "Title goes here..."
4+
labels: ["bug"]
5+
body:
6+
- type: input
7+
id: pyshp-version
8+
attributes:
9+
label: PyShp Version
10+
description: Please input the version of PyShp you used. If unsure, call `shapefile.__version__`.
11+
placeholder: ...
12+
validations:
13+
required: true
14+
- type: input
15+
id: python-version
16+
attributes:
17+
label: Python Version
18+
description: Please input the version of the Python executable.
19+
placeholder: ...
20+
validations:
21+
required: true
22+
- type: textarea
23+
id: your-code
24+
attributes:
25+
label: Your code
26+
description: Please copy-paste the relevant parts of your code or script that you tried to run.
27+
placeholder: ...
28+
render: shell
29+
validations:
30+
required: true
31+
- type: textarea
32+
id: expected-results
33+
attributes:
34+
label: Expected results
35+
description: Please describe what you expected to see in the output.
36+
placeholder: ...
37+
validations:
38+
required: true
39+
- type: textarea
40+
id: actual-results
41+
attributes:
42+
label: Actual results
43+
description: Please describe what you actually saw in the output.
44+
placeholder: ...
45+
validations:
46+
required: true
47+
- type: textarea
48+
id: notes
49+
attributes:
50+
label: Other notes
51+
description: Please input any other notes that may be relevant, e.g. do you have any thoughts on what might be wrong?
52+
placeholder: ...
53+
validations:
54+
required: false

0 commit comments

Comments
 (0)