Skip to content

Instantly share code, notes, and snippets.

@Anmol-Baranwal
Created October 3, 2022 15:13
Show Gist options
  • Save Anmol-Baranwal/cccf913ada8f9b0f0d178fdcf0a2d0f5 to your computer and use it in GitHub Desktop.
Save Anmol-Baranwal/cccf913ada8f9b0f0d178fdcf0a2d0f5 to your computer and use it in GitHub Desktop.
Basic Issue Templates in yml format
name: "🐛 Bug Report"
description: Create a new ticket for a bug.
title: "🐛 [BUG] - <title>"
labels: [
"bug"
]
body:
- type: textarea
id: description
attributes:
label: "Description"
description: Please enter an explicit description of your issue
placeholder: Short and explicit description of your incident...
validations:
required: true
- type: input
id: reprodURL
attributes:
label: "Reproduction URL"
description: Please enter your GitHub URL to provide a reproduction of the issue
placeholder: ex. https://github.com/USERNAME/REPO-NAME
validations:
required: true
- type: textarea
id: reproductionStep
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: screenshot
attributes:
label: "Screenshots"
description: If applicable, add screenshots to help explain your problem.
value: |
![DESCRIPTION](LINK.png)
render: bash
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: dropdown
id: browsers
attributes:
label: "Browsers"
description: What browsers are you seeing the problem on ?
multiple: true
options:
- Firefox
- Chrome
- Safari
- Microsoft Edge
- Opera
validations:
required: false
- type: dropdown
id: os
attributes:
label: "OS"
description: What is the impacted environment ?
multiple: true
options:
- Windows
- Linux
- Mac
validations:
required: false
name: Contact Support
description: Contact support and get help
title: Contact Support
labels: 'support'
body:
- type: markdown
attributes:
value: |
# Contact Support
- type: textarea
id: description
attributes:
label: Description
description: Describe your issue or question here
placeholder: Tell us what you need help with
validations:
required: true
- type: textarea
id: screenshot
attributes:
label: Screenshots
description: If applicable, add screenshots to help explain your problem.
placeholder: Add screenshots here
validations:
required: false
- type: textarea
id: logs
attributes:
label: Logs
description: If applicable, add logs to help explain your problem.
placeholder: Add logs here
validations:
required: false
- type: input
id: contact
attributes:
label: Contact Details
description: How can we get in touch with you?
placeholder: ex.
validations:
required: true
- type: checkboxes
id: terms
attributes:
label: Code of Conduct
description: By submitting this issue, you agree to follow our [Code of Conduct](/CODE_OF_CONDUCT.md)
options:
- label: I agree to follow this project's Code of Conduct
required: true
name: "💡 Feature Request"
description: Create a new ticket for a new feature request
title: "💡 [REQUEST] - <title>"
labels: [
"question"
]
body:
- type: input
id: startDate
attributes:
label: "Start Date"
description: Start of development
placeholder: "month/day/year"
validations:
required: false
- type: textarea
id: implementationPR
attributes:
label: "Implementation PR"
description: Pull request used
placeholder: "#Pull Request ID"
validations:
required: false
- type: textarea
id: referenceIssues
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: basicExample
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: unresolvedQuestion
attributes:
label: "Unresolved questions"
description: What questions still remain unresolved ?
placeholder: Identify any unresolved issues.
validations:
required: false
name: Other
description: Describe anything here.
title: Other <subject>
labels: [question, Others]
body:
- type: markdown
attributes:
value: "# Other issue"
- type: textarea
id: isDescription
attributes:
label: What would you like to share?
description: Provide a clear and concise explanation of your issue.
validations:
required: true
- type: textarea
id: extraInfo
attributes:
label: Additional information
description: Is there anything else I should know about this issue?
validations:
required: false
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment