Enhance issue templates. (#522)

pytask-dev · Dec 8, 2023 · ff997b0 · ff997b0
1 parent 45fdf59
commit ff997b0
Show file tree

Hide file tree

Showing 4 changed files with 6 additions and 7 deletions.
diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md
@@ -8,9 +8,7 @@ labels: "bug"
 ---
 
 - [ ] I have checked that this issue has not already been reported.
-
 - [ ] I have confirmed this bug exists on the latest version of pytask.
-
 - [ ] (optional) I have confirmed this bug exists on the `main` branch of pytask.
 
 ---
@@ -27,7 +25,7 @@ how to provide the necessary information for us to reproduce your bug.
 
 #### Problem description
 
-Explain **why** the current behaviour is a problem and why the expected output is a
+Explain **why** the current behavior is a problem and why the expected output is a
 better solution.
 
 #### Expected Output
diff --git a/.github/ISSUE_TEMPLATE/documentation.md b/.github/ISSUE_TEMPLATE/documentation.md
@@ -16,7 +16,7 @@ Provide the location of the documentation, e.g. an URL of the documentation.
 
 #### Documentation problem
 
-Provide a description of what documentation you believe needs to be fixed/improved.
+Describe what documentation you believe needs to be fixed/improved.
 
 #### Suggested fix for documentation
 

diff --git a/.github/ISSUE_TEMPLATE/enhancement.md b/.github/ISSUE_TEMPLATE/enhancement.md
@@ -14,15 +14,15 @@ Provide a description of what the problem is, e.g. "I wish I could use pytask to
 
 #### Describe the solution you'd like
 
-Provide a description of the feature request and how it might be implemented.
+Describe the feature request and how it might be implemented.
 
 #### API breaking implications
 
-Provide a description of how this feature will affect the API.
+Describe how this feature will affect the API.
 
 #### Describe alternatives you've considered
 
-Provide a description of any alternative solutions or features you've considered.
+Describe any alternative solutions or features you've considered.
 
 #### Additional context
 

diff --git a/docs/source/changes.md b/docs/source/changes.md
@@ -13,6 +13,7 @@ releases are available on [PyPI](https://pypi.org/project/pytask) and
   strings.
 - {pull}`519` raises an error when builtin functions are wrapped with
   {func}`~pytask.task`. Closes {issue}`512`.
+- {pull}`522` improves the issue templates.
 
 ## 0.4.4 - 2023-12-04