Skip to content

Commit fff3070

Browse files
committed
docs: change issue templates to forms
1 parent 9ae0239 commit fff3070

File tree

6 files changed

+136
-102
lines changed

6 files changed

+136
-102
lines changed

.github/ISSUE_TEMPLATE/01-bug-report.md

Lines changed: 0 additions & 49 deletions
This file was deleted.
Lines changed: 64 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,64 @@
1+
name: 🐞 Bug report
2+
description: Report a problem to help improve this project
3+
title: "[BUG] "
4+
labels: [bug, triage]
5+
body:
6+
- type: checkboxes
7+
attributes:
8+
label: Is there an existing issue for this?
9+
description: Please search to see if an [issue already exists](https://github.com/opencobra/cobrapy/issues) for the bug you encountered.
10+
options:
11+
- label: I have searched the existing issues
12+
required: true
13+
- type: textarea
14+
attributes:
15+
label: Problem description
16+
description: |
17+
A concise description of what you're experiencing.
18+
19+
Please explain:
20+
21+
* **what** you tried to achieve,
22+
* **how** you went about it (referring to the code sample), and
23+
* **why** the current behaviour is a problem and what output you expected instead.
24+
validations:
25+
required: false
26+
- type: textarea
27+
attributes:
28+
label: Code sample
29+
description: >
30+
Create a [minimal, complete, verifiable example](https://stackoverflow.com/help/mcve).
31+
Please, paste your code between the ``` tickmarks below or link to a [gist](https://gist.github.com/).
32+
value: |
33+
Code run:
34+
35+
```python
36+
```
37+
38+
Traceback:
39+
40+
```text
41+
```
42+
validations:
43+
required: false
44+
- type: textarea
45+
attributes:
46+
label: Environment
47+
description: >
48+
Please paste the output of running `depinfo --markdown cobra`
49+
in your environment between the `details` tags below.
50+
value: |
51+
<details>
52+
53+
</details>
54+
validations:
55+
required: true
56+
- type: textarea
57+
attributes:
58+
label: Anything else?
59+
description: |
60+
Links? References? Anything that will give us more context about the issue you are encountering!
61+
62+
Tip: You can attach images or log files by clicking this area to highlight it and then dragging files in.
63+
validations:
64+
required: false

.github/ISSUE_TEMPLATE/02-question.md

Lines changed: 0 additions & 17 deletions
This file was deleted.
Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
name: Question
2+
description: Ask a question
3+
title: "[Question] "
4+
labels: [question]
5+
body:
6+
- type: checkboxes
7+
attributes:
8+
label: Checklist
9+
description: >
10+
To help keep this issue tracker clean and focused, please make sure that you have
11+
tried *all* of the following resources before submitting your question.
12+
options:
13+
- label: I searched the [documentation](https://cobra.readthedocs.io).
14+
required: true
15+
- label: I looked through existing [discussion topics](https://github.com/opencobra/cobrapy/discussions).
16+
required: true
17+
- label: I looked for [similar issues](https://github.com/opencobra/cobrapy/issues).
18+
required: true
19+
- label: I looked up my question/problem in a search engine.
20+
required: true
21+
- type: textarea
22+
attributes:
23+
label: Question
24+
description: Please ask your question
25+
validations:
26+
required: true

.github/ISSUE_TEMPLATE/03-feature-request.md

Lines changed: 0 additions & 36 deletions
This file was deleted.
Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
2+
name: Feature request
3+
description: Suggest an idea for this project
4+
title: "[Feature] "
5+
labels: [enhancement]
6+
body:
7+
- type: checkboxes
8+
attributes:
9+
label: Checklist
10+
description: >
11+
Please make sure you check all these items before submitting your feature request.
12+
options:
13+
- label: There are [no similar issues or pull requests](https://github.com/opencobra/cobrapy/issues) for this yet.
14+
required: true
15+
- type: textarea
16+
attributes:
17+
label: Problem
18+
description: >
19+
A clear and concise description of what you are trying to achieve.
20+
placeholder: >
21+
"I want to be able to [...] but I can't because [...]".
22+
validations:
23+
required: false
24+
- type: textarea
25+
attributes:
26+
label: Solution
27+
description: >
28+
A clear and concise description of what you would want to happen.
29+
For API changes, try to provide a code snippet of what you would like the new API to look like.
30+
validations:
31+
required: false
32+
- type: textarea
33+
attributes:
34+
label: Alternatives
35+
description: >
36+
Please describe any alternative solutions or features you've considered to solve
37+
your problem and why they didn't help.
38+
validations:
39+
required: false
40+
- type: textarea
41+
attributes:
42+
label: Anything else?
43+
description: >
44+
Provide any additional context, screenshots, tracebacks, etc. about the feature here.
45+
validations:
46+
required: false

0 commit comments

Comments
 (0)