Skip to content

Commit ec69b3d

Browse files
committed
add issue templates
1 parent 3f9b31a commit ec69b3d

File tree

4 files changed

+92
-0
lines changed

4 files changed

+92
-0
lines changed
Lines changed: 67 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,67 @@
1+
name: Bug Report
2+
description: Create a report if something doesn't work quite right.
3+
labels: ["bug", "needs triage"]
4+
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Thanks for taking the time to fill out this bug report!
10+
11+
- type: checkboxes
12+
id: checks
13+
attributes:
14+
label: Version Checks (indicate both or one)
15+
options:
16+
- label: >
17+
I have confirmed this bug exists on the lastest
18+
[release](https://github.com/pypsa/linopy/releases) of Linopy.
19+
- label: >
20+
I have confirmed this bug exists on the current
21+
[`master`](https://github.com/pypsa/linopy/tree/master) branch of Linopy.
22+
23+
- type: textarea
24+
id: problem
25+
attributes:
26+
label: Issue Description
27+
description: >
28+
Please provide a description of the issue.
29+
validations:
30+
required: true
31+
32+
- type: textarea
33+
id: example
34+
validations:
35+
required: true
36+
attributes:
37+
label: Reproducible Example
38+
description: >
39+
Please provide a minimal reproduciable example. See how to [craft minimal bug reports](https://matthewrocklin.com/minimal-bug-reports).
40+
placeholder: >
41+
from linopy import Model
42+
43+
m = Model()
44+
45+
render: python
46+
47+
- type: textarea
48+
id: expected-behavior
49+
validations:
50+
required: true
51+
attributes:
52+
label: Expected Behavior
53+
description: >
54+
Please describe or show a code example of the expected behavior.
55+
56+
- type: textarea
57+
id: version
58+
attributes:
59+
label: Installed Versions
60+
description: >
61+
Please share information on your environment. Paste the output below. For conda ``conda env export`` and for pip ``pip freeze``.
62+
value: >
63+
<details>
64+
65+
Replace this line.
66+
67+
</details>

.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
Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
---
2+
name: Feature Request
3+
about: Suggest an idea for this project
4+
title: ''
5+
labels: ["feature", "needs triage"]
6+
assignees: ''
7+
8+
---
9+
10+
## Describe the feature you'd like to see
11+
12+
*Please give a clear and concise description and provide context why the feature would be useful.*
13+
*Also, we'd appreciate any implementation ideas and references you already have.*

.github/pull_request_template.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
Closes # (if applicable).
2+
3+
## Changes proposed in this Pull Request
4+
5+
6+
## Checklist
7+
8+
- [ ] Code changes are sufficiently documented; i.e. new functions contain docstrings and further explanations may be given in `doc`.
9+
- [ ] Unit tests for new features were added (if applicable).
10+
- [ ] A note for the release notes `doc/release_notes.rst` of the upcoming release is included.
11+
- [ ] I consent to the release of this PR's code under the MIT license.

0 commit comments

Comments
 (0)