add templates
Signed-off-by: Manabu McCloskey <manabu.mccloskey@gmail.com>
This commit is contained in:
commit
11cad6e032
3 changed files with 94 additions and 0 deletions
44
.github/ISSUE_TEMPLATE/bug_report.yaml
vendored
Normal file
44
.github/ISSUE_TEMPLATE/bug_report.yaml
vendored
Normal file
|
|
@ -0,0 +1,44 @@
|
|||
name: 🐞 Bug Report
|
||||
title: "[Bug]: <title>"
|
||||
description: Create a report to help us improve
|
||||
labels: ["bug", "triage"]
|
||||
body:
|
||||
- type: markdown
|
||||
attributes:
|
||||
value: |
|
||||
### How to write a good bug report?
|
||||
|
||||
- Respect the issue template as much as possible.
|
||||
- The title should be short and descriptive.
|
||||
- Explain the conditions which led you to report this issue and the context.
|
||||
- The context should lead to something, an idea or a problem that you’re facing.
|
||||
- Remain clear and concise.
|
||||
- Format your messages to help the reader focus on what matters and understand the structure of your message, use [Markdown syntax](https://help.github.com/articles/github-flavored-markdown)
|
||||
|
||||
- type: textarea
|
||||
attributes:
|
||||
label: What is your environment, configuration, and command?
|
||||
description: |
|
||||
Use [Markdown syntax](https://help.github.com/articles/github-flavored-markdown) if needed.
|
||||
placeholder: Add information here.
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: textarea
|
||||
attributes:
|
||||
label: What did you do and What did you see instead?
|
||||
description: |
|
||||
Provide error details and the expected details.
|
||||
|
||||
Use [Markdown syntax](https://help.github.com/articles/github-flavored-markdown) if needed.
|
||||
placeholder: Add information here.
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: textarea
|
||||
attributes:
|
||||
label: Additional Information. Logs.
|
||||
description: Use [Markdown syntax](https://help.github.com/articles/github-flavored-markdown) if needed.
|
||||
placeholder: Add information here.
|
||||
validations:
|
||||
required: false
|
||||
1
.github/ISSUE_TEMPLATE/config.yml
vendored
Normal file
1
.github/ISSUE_TEMPLATE/config.yml
vendored
Normal file
|
|
@ -0,0 +1 @@
|
|||
blank_issues_enabled: true
|
||||
49
.github/ISSUE_TEMPLATE/feature.yaml
vendored
Normal file
49
.github/ISSUE_TEMPLATE/feature.yaml
vendored
Normal file
|
|
@ -0,0 +1,49 @@
|
|||
name: Feature Proposal
|
||||
description: 'Submit a proposal for a new feature'
|
||||
title: 'Feature: <title>'
|
||||
labels: [enhancement]
|
||||
body:
|
||||
- type: markdown
|
||||
attributes:
|
||||
value: |
|
||||
### Creating feature request:
|
||||
|
||||
- Respect the issue template as much as possible.
|
||||
- The title should be short and descriptive.
|
||||
- Remain clear and concise.
|
||||
- Use of examples is a big plus.
|
||||
|
||||
- type: checkboxes
|
||||
id: duplicate
|
||||
attributes:
|
||||
label: 'Have you searched for this feature request?'
|
||||
options:
|
||||
- label: "I searched but did not find similar requests"
|
||||
required: true
|
||||
|
||||
- type: textarea
|
||||
id: description
|
||||
validations:
|
||||
required: true
|
||||
attributes:
|
||||
label: 'Problem Statement'
|
||||
description: 'Please provide a clear and concise problem statement'
|
||||
placeholder: 'idpbuilder does this right now, but this does not support my use case because...'
|
||||
|
||||
- type: textarea
|
||||
id: solution
|
||||
validations:
|
||||
required: true
|
||||
attributes:
|
||||
label: 'Possible Solution'
|
||||
description: 'Please explain what you think is a good solution for this problem'
|
||||
placeholder: 'I think idpbuilder should do this and that...'
|
||||
|
||||
- type: textarea
|
||||
id: alternatives
|
||||
validations:
|
||||
required: false
|
||||
attributes:
|
||||
label: 'Alternatives Considered'
|
||||
description: 'Please provide any alternative solutions you have considered'
|
||||
placeholder: 'OPTIONAL. Providing this information helps us follow your thought process'
|
||||
Loading…
Add table
Add a link
Reference in a new issue