Skip to content

Commit

Permalink
Issue templates (#111)
Browse files Browse the repository at this point in the history
  • Loading branch information
tavisit authored May 3, 2023
1 parent 07367e4 commit b14796d
Show file tree
Hide file tree
Showing 4 changed files with 141 additions and 0 deletions.
59 changes: 59 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,59 @@
name: Bug Report
description: File a bug report
title: "[Bug]: "
labels: ["bug"]
body:
- type: markdown
attributes:
value: |
Thanks for taking the time to fill out this bug report!
- type: textarea
attributes:
label: Environment
description: |
examples:
- **QF-Lib**: 2.5.6
- **Python**: 3.9
value: |
- QF-LIB:
- Python:
render: markdown
validations:
required: false
- type: textarea
id: what-happened
attributes:
label: What happened?
description: Also tell us, what did you expect to happen?
placeholder: Tell us what you see!
validations:
required: true
- type: textarea
id: screenshot
attributes:
label: "Screenshots"
description: If applicable, add screenshots to help explain your problem.
value: |
![DESCRIPTION](LINK.png)
render: bash
validations:
required: true
- type: textarea
id: reprod
attributes:
label: "Reproduction steps"
description: Please enter an explicit description of your issue
value: |
1. Go to '...'
2. Click on '....'
3. Scroll down to '....'
4. See error
render: bash
validations:
required: true
- type: textarea
id: logs
attributes:
label: Relevant log output
description: Please copy and paste any relevant log output. This will be automatically formatted into code, so no need for backticks.
render: shell
18 changes: 18 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
name: Feature request
description: Suggest an feature / idea for this project
title: "[Feature Request / Suggestion]: "
labels: ["enhancement", "request"]
body:
- type: markdown
attributes:
value: |
We appreciate your feedback on how to improve this project. Please be sure to include as much details & any resources if possible!
- type: textarea
id: Suggestion
attributes:
label: Suggestion / Feature Request
description: Describe the feature(s) you would like to see added.
placeholder: Tell us your suggestion
value: "Your suggestion here"
validations:
required: true
11 changes: 11 additions & 0 deletions .github/ISSUE_TEMPLATE/other_report.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
name: Other Issue
description: Other kind of the issue
title: "[Issue]: "
body:
- type: textarea
id: summary
attributes:
label: Summary
description: Any precise description of the issue
validations:
required: true
53 changes: 53 additions & 0 deletions .github/ISSUE_TEMPLATE/pull_request_feature.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
name: Pull Request Feature
description: Create a new ticket for a new feature request
title: "[REQUEST]: "
labels: ["pull_request", "request"]
body:
- type: textarea
id: implementation_pr
attributes:
label: "Implementation PR"
description: Pull request used
placeholder: "#Pull Request ID"
validations:
required: false
- type: textarea
id: reference_issues
attributes:
label: "Reference Issues"
description: Common issues
placeholder: "#Issues IDs"
validations:
required: false
- type: textarea
id: summary
attributes:
label: "Summary"
description: Provide a brief explanation of the feature
placeholder: Describe in a few lines your feature request
validations:
required: true
- type: textarea
id: basic_example
attributes:
label: "Basic Example"
description: Indicate here some basic examples of your feature.
placeholder: A few specific words about your feature request.
validations:
required: true
- type: textarea
id: drawbacks
attributes:
label: "Drawbacks"
description: What are the drawbacks/impacts of your feature request ?
placeholder: Identify the drawbacks and impacts while being neutral on your feature request
validations:
required: true
- type: textarea
id: unresolved_question
attributes:
label: "Unresolved questions"
description: What questions still remain unresolved ?
placeholder: Identify any unresolved issues.
validations:
required: false

0 comments on commit b14796d

Please sign in to comment.