Skip to content

Commit

Permalink
infra: fix health files (#322)
Browse files Browse the repository at this point in the history
  • Loading branch information
JacobCoffee committed Aug 2, 2023
1 parent 8ff7e0f commit 5543e66
Show file tree
Hide file tree
Showing 3 changed files with 132 additions and 0 deletions.
82 changes: 82 additions & 0 deletions .github/ISSUE_TEMPLATE/BUG.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,82 @@
name: "Bug Report"
description: Create an issue for a bug.
title: "Bug: <title>"
labels: ["bug", "triage required"]
body:
- type: textarea
id: description
attributes:
label: "Description"
description: Please enter an description of the bug you are encountering
placeholder:
validations:
required: true
- type: input
id: reprod-url
attributes:
label: "URL to code causing the issue"
description: Please enter the URL to provide a reproduction of the issue, if applicable
placeholder: ex. https://github.com/USERNAME/REPO-NAME
validations:
required: false
- type: textarea
id: mcve
attributes:
label: "MCVE"
description: "Please provide a minimal, complete, and verifiable example of the issue."
value: |
```py
# Your MCVE code here
```
render: python
validations:
required: false
- type: textarea
id: reprod
attributes:
label: "Steps to reproduce"
description: Please enter the exact steps to reproduce the issue
value: |
1. Go to '...'
2. Click on '....'
3. Scroll down to '....'
4. See error
render: bash
validations:
required: false
- type: textarea
id: screenshot
attributes:
label: "Screenshots"
description: If applicable, add screenshots to help explain your problem.
value: |
"In the format of: `![SCREENSHOT_DESCRIPTION](SCREENSHOT_LINK.png)`"
validations:
required: false
- type: textarea
id: logs
attributes:
label: "Logs"
description: Please copy and paste any relevant log output. This will be automatically formatted into code, so no need for backticks.
render: bash
validations:
required: false
- type: textarea
id: version
attributes:
label: "Release Version"
description: What version of the project are you using when encountering this issue?
validations:
required: true
- type: checkboxes
id: platform
attributes:
label: "Platform"
description: What platform are you encountering the issue on?
options:
- label: "Linux"
- label: "Mac"
- label: "Windows"
- label: "Other (Please specify in the description above)"
validations:
required: false
13 changes: 13 additions & 0 deletions .github/ISSUE_TEMPLATE/DOCS.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
name: "Documentation Update"
description: Create an issue for documentation changes
title: "Docs: <title>"
labels: ["documentation"]
body:
- type: textarea
id: summary
attributes:
label: "Summary"
description: Provide a brief summary of your feature request
placeholder: Describe in a few lines your feature request
validations:
required: true
37 changes: 37 additions & 0 deletions .github/ISSUE_TEMPLATE/REQUEST.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
name: "Feature Request"
description: Create an issue for a new feature request
title: "Enhancement: <title>"
labels: ["enhancement"]
body:
- type: textarea
id: summary
attributes:
label: "Summary"
description: Provide a brief summary of your feature request
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: Provide some basic example of your feature request
validations:
required: false
- type: textarea
id: drawbacks
attributes:
label: "Drawbacks and Impact"
description: What are the drawbacks or impacts of your feature request?
placeholder: Describe any the drawbacks or impacts of your feature request
validations:
required: false
- type: textarea
id: unresolved_question
attributes:
label: "Unresolved questions"
description: What, if any, unresolved questions do you have about your feature request?
placeholder: Identify any unresolved issues.
validations:
required: false

0 comments on commit 5543e66

Please sign in to comment.