Skip to content

Commit 2532095

Browse files
committed
ISSUE TEMPLATES
1 parent 8e69734 commit 2532095

File tree

4 files changed

+98
-0
lines changed

4 files changed

+98
-0
lines changed
Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
---
2+
3+
name: Bug Report
4+
about: Create a bug report to help us improve staircase
5+
title: "BUG:"
6+
labels: "Bug"
7+
8+
---
9+
10+
- [ ] I have checked that this issue has not already been reported.
11+
12+
- [ ] I have confirmed this bug exists on the latest version of staircase.
13+
14+
---
15+
16+
**Note**: Please read [this guide](https://matthewrocklin.com/blog/work/2018/02/28/minimal-bug-reports) detailing how to provide the necessary information for us to reproduce your bug.
17+
18+
#### Code Sample, a copy-pastable example
19+
20+
```python
21+
# Your code here
22+
23+
```
24+
25+
#### Problem description
26+
27+
[this should explain **why** the current behaviour is a problem and why the expected output is a better solution]
28+
29+
#### Expected Output
30+
31+
#### Dependency Versions``
32+
33+
Please run the following code:
34+
35+
```python
36+
import staircase
37+
import pandas
38+
import numpy
39+
40+
for pkg in (staircase, pandas, numpy):
41+
print(pkg.__version__)
42+
43+
<details>
44+
45+
[paste the output here leaving a blank line after the details tag]
46+
47+
</details>
Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
---
2+
3+
name: Documentation Improvement
4+
about: Report wrong or missing documentation
5+
title: "DOC:"
6+
labels: "Documentation"
7+
8+
---
9+
10+
#### Location of the documentation
11+
12+
[this should provide the location of the documentation, e.g. "https://www.staircase.dev/en/latest/reference/api/staircase.Stairs.fillna.html"]
13+
14+
**Note**: You can check the latest versions of the docs on `master` [here](https://www.staircase.dev/en/master/).
15+
16+
#### Documentation problem
17+
18+
[this should provide a description of what documentation you believe needs to be fixed/improved]
19+
20+
#### Suggested fix for documentation
21+
22+
[this should explain the suggested fix and **why** it's better than the existing documentation]
Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
---
2+
3+
name: Feature Request
4+
about: Suggest an enhancement for staircase
5+
title: "ENH:"
6+
labels: "Enhancement"
7+
8+
---
9+
10+
#### Is your feature request related to a problem?
11+
12+
[if so, what is the problem? What do you want to do?"]
13+
14+
#### Describe the solution you'd like
15+
16+
[a DETAILED description of the feature request]
17+
18+
#### Additional context
19+
20+
[add any other context, code examples, or references to existing implementations about the feature request here]
21+
22+
```python
23+
# Your code here, if applicable
24+
25+
```

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
- [ ] closes #xxxx
2+
- [ ] tests added / passed
3+
- [ ] ensure all linting tests pass
4+
- [ ] changelog entry

0 commit comments

Comments
 (0)