Skip to content

Commit ff997b0

Browse files
authored
Enhance issue templates. (#522)
1 parent 45fdf59 commit ff997b0

File tree

4 files changed

+6
-7
lines changed

4 files changed

+6
-7
lines changed

.github/ISSUE_TEMPLATE/bug_report.md

+1-3
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,7 @@ labels: "bug"
88
---
99

1010
- [ ] I have checked that this issue has not already been reported.
11-
1211
- [ ] I have confirmed this bug exists on the latest version of pytask.
13-
1412
- [ ] (optional) I have confirmed this bug exists on the `main` branch of pytask.
1513

1614
---
@@ -27,7 +25,7 @@ how to provide the necessary information for us to reproduce your bug.
2725

2826
#### Problem description
2927

30-
Explain **why** the current behaviour is a problem and why the expected output is a
28+
Explain **why** the current behavior is a problem and why the expected output is a
3129
better solution.
3230

3331
#### Expected Output

.github/ISSUE_TEMPLATE/documentation.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ Provide the location of the documentation, e.g. an URL of the documentation.
1616

1717
#### Documentation problem
1818

19-
Provide a description of what documentation you believe needs to be fixed/improved.
19+
Describe what documentation you believe needs to be fixed/improved.
2020

2121
#### Suggested fix for documentation
2222

.github/ISSUE_TEMPLATE/enhancement.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -14,15 +14,15 @@ Provide a description of what the problem is, e.g. "I wish I could use pytask to
1414

1515
#### Describe the solution you'd like
1616

17-
Provide a description of the feature request and how it might be implemented.
17+
Describe the feature request and how it might be implemented.
1818

1919
#### API breaking implications
2020

21-
Provide a description of how this feature will affect the API.
21+
Describe how this feature will affect the API.
2222

2323
#### Describe alternatives you've considered
2424

25-
Provide a description of any alternative solutions or features you've considered.
25+
Describe any alternative solutions or features you've considered.
2626

2727
#### Additional context
2828

docs/source/changes.md

+1
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@ releases are available on [PyPI](https://pypi.org/project/pytask) and
1313
strings.
1414
- {pull}`519` raises an error when builtin functions are wrapped with
1515
{func}`~pytask.task`. Closes {issue}`512`.
16+
- {pull}`522` improves the issue templates.
1617

1718
## 0.4.4 - 2023-12-04
1819

0 commit comments

Comments
 (0)