-
Notifications
You must be signed in to change notification settings - Fork 3
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #99 from JGCRI/feature/workflows
Issue and PR templates
- Loading branch information
Showing
4 changed files
with
110 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,33 @@ | ||
--- | ||
|
||
name: Bug Report | ||
about: Create a bug report to help us improve stitches | ||
title: "BUG:" | ||
labels: "Bug, Needs Triage" | ||
|
||
--- | ||
|
||
- [ ] I have checked that this issue has not already been reported. | ||
|
||
- [ ] I have confirmed this bug exists on the latest version of stitches. | ||
|
||
- [ ] (optional) I have confirmed this bug exists on the master branch of stitches. | ||
|
||
--- | ||
|
||
**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. | ||
|
||
#### Code Sample, a copy-pastable example | ||
|
||
```python | ||
# Your code here | ||
|
||
``` | ||
|
||
#### Problem description | ||
|
||
[this should explain **why** the current behaviour is a problem and why the expected output is a better solution] | ||
|
||
#### Expected Output | ||
|
||
[paste your formatted output here] |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,20 @@ | ||
--- | ||
|
||
name: Documentation Improvement | ||
about: Report erroneous or missing documentation | ||
title: "DOC:" | ||
labels: "Docs, Needs Triage" | ||
|
||
--- | ||
|
||
#### Location of the documentation | ||
|
||
[A link to the file containing the documentation in question] | ||
|
||
#### Documentation problem | ||
|
||
[this should provide a description of what documentation you believe needs to be fixed/improved] | ||
|
||
#### Suggested fix for documentation | ||
|
||
[this should explain the suggested fix and **why** it's better than the existing documentation] |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,33 @@ | ||
--- | ||
|
||
name: Feature Request | ||
about: Suggest an idea for stitches | ||
title: "ENH:" | ||
labels: "Enhancement, Needs Triage" | ||
|
||
--- | ||
|
||
#### Is your feature request related to a problem? | ||
|
||
[this should provide a description of what the problem is, e.g. "I wish I could use stitches to do [...]"] | ||
|
||
#### Describe the solution you'd like | ||
|
||
[this should provide a description of the feature request] | ||
|
||
#### API breaking implications | ||
|
||
[this should provide a description of how this feature will affect the API] | ||
|
||
#### Describe alternatives you've considered | ||
|
||
[this should provide a description of any alternative solutions or features you've considered] | ||
|
||
#### Additional context | ||
|
||
[add any other context, code examples, or references to existing implementations about the feature request here] | ||
|
||
```python | ||
# Your code here, if applicable | ||
|
||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,24 @@ | ||
**Purpose:** | ||
|
||
Short description of the purpose of this PR | ||
|
||
**New version:** | ||
|
||
Then new version number if one is to be issued | ||
|
||
**Related:** | ||
|
||
Any related pull requests or issues from other repositories | ||
|
||
**Resolved:** | ||
|
||
Any issues to resolve automatically upon merge. Use the keyword with the number of the target issue (e.g., `Resolve #59`) | ||
|
||
**Incorporated:** | ||
|
||
Any pull requests already merged that this one may include. This is usually the case when feature and bug fix branches have been merged into the `dev` branch then these are staged to be merged into the `main` | ||
|
||
|
||
**Comments:** | ||
|
||
Any additional comments. |