-
Notifications
You must be signed in to change notification settings - Fork 19
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 #161 from trevorb1/issue-templates
Added issue and PR templates
- Loading branch information
Showing
4 changed files
with
193 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,89 @@ | ||
name: Bug Report | ||
description: File a bug report | ||
title: "[Bug]: <Replace with short description of bug>" | ||
labels: ["bug"] | ||
# assignees: | ||
# - trevorb1 | ||
body: | ||
|
||
- type: textarea | ||
attributes: | ||
label: The Issue | ||
description: A concise description of the issue you are experiencing. | ||
validations: | ||
required: true | ||
|
||
- type: textarea | ||
attributes: | ||
label: Expected Behavior | ||
description: A concise description of what you expected to happen. | ||
validations: | ||
required: false | ||
|
||
- type: textarea | ||
attributes: | ||
label: Steps To Reproduce | ||
description: How do you trigger this bug? Please walk us through it step by step. | ||
placeholder: | | ||
1. Running this command... | ||
2. With this config.yaml file data... | ||
validations: | ||
required: false | ||
|
||
- type: textarea | ||
id: logs | ||
attributes: | ||
label: Log output | ||
description: | | ||
Please copy and paste any relevant log output. This will be automatically formatted into code, so no need for backticks. | ||
To include the full traceback error, run otoole in verbose mode with the "-v" flag | ||
render: shell | ||
validations: | ||
required: false | ||
|
||
- type: dropdown | ||
id: os | ||
attributes: | ||
label: Operating System | ||
description: What operating system are you running? | ||
options: | ||
- Linux | ||
- MacOS | ||
- Windows | ||
validations: | ||
required: true | ||
|
||
- type: input | ||
id: version | ||
attributes: | ||
label: What version of otoole are you running? | ||
description: | | ||
To check your version, use the command "otoole -V" | ||
validations: | ||
required: true | ||
|
||
- type: textarea | ||
id: solution | ||
attributes: | ||
label: Possible Solution | ||
description: Do you have an idea on how to fix the issue? | ||
validations: | ||
required: false | ||
|
||
- type: textarea | ||
id: other | ||
attributes: | ||
label: Anything else? | ||
description: | | ||
Tip: You can attach images or log files by clicking this area to highlight it and then dragging files in. | ||
validations: | ||
required: false | ||
|
||
# - type: checkboxes | ||
# id: terms | ||
# attributes: | ||
# label: Code of Conduct | ||
# description: By submitting this issue, you agree to follow our [Code of Conduct](https://example.com) | ||
# options: | ||
# - label: I agree to follow this project's Code of Conduct | ||
# required: true |
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,53 @@ | ||
name: Documentation | ||
description: Issues relating to documentation | ||
title: "[DOCS] <Replace with short description of documentation issue>" | ||
labels: ["documentation"] | ||
body: | ||
|
||
- type: dropdown | ||
id: issuetype | ||
attributes: | ||
label: Type of documentation issue. | ||
multiple: true | ||
options: | ||
- Missing Information | ||
- Incorect Information | ||
- Typo | ||
- Other | ||
validations: | ||
required: true | ||
|
||
- type: textarea | ||
id: description | ||
attributes: | ||
label: Issue Description | ||
description: Detailed description of the documentation issue. | ||
placeholder: | | ||
ie. There is no description of how to convert from excel files | ||
validations: | ||
required: true | ||
|
||
- type: textarea | ||
id: current | ||
attributes: | ||
label: Link to existing documentation | ||
description: If applicable, provide the link to the current documentation location | ||
validations: | ||
required: false | ||
|
||
- type: textarea | ||
id: solution | ||
attributes: | ||
label: Suggested Update | ||
description: Do you have an idea on how to update the documention? | ||
validations: | ||
required: false | ||
|
||
- type: textarea | ||
id: other | ||
attributes: | ||
label: Additional Info | ||
description: | | ||
Please provide any additional information to help fix this documentation issue. | ||
validations: | ||
required: false |
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,39 @@ | ||
name: Feature request | ||
description: Ideas to improve the otoole | ||
title: "[FEATURE] <Replace with short description of feature request>" | ||
labels: ["enhancement"] | ||
body: | ||
|
||
- type: textarea | ||
id: request | ||
attributes: | ||
label: Feature Request | ||
description: Detailed description the suggested improvement | ||
validations: | ||
required: true | ||
|
||
- type: input | ||
id: bug | ||
attributes: | ||
label: Is your feature related to a bug? | ||
description: If applicable, refer to a an existing bug using the `#bugid` keyword | ||
placeholder: "#bugid 10" | ||
validations: | ||
required: false | ||
|
||
- type: textarea | ||
id: solution | ||
attributes: | ||
label: Suggested Solution | ||
description: Do you have an idea on how to implement the idea? | ||
validations: | ||
required: false | ||
|
||
- type: textarea | ||
id: other | ||
attributes: | ||
label: Additional Info | ||
description: | | ||
Please provide any additional information or resources that will help us implement the idea. | ||
validations: | ||
required: false |
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,12 @@ | ||
<!--- Provide a short description of the pull request --> | ||
|
||
### Description | ||
<!--- Describe your changes in detail --> | ||
|
||
|
||
### Issue Ticket Number | ||
<!--- Link corresponding issue number --> | ||
|
||
|
||
### Documentation | ||
<!--- Where and how has this change been documented --> |