Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Feature: add issue templates #13

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
53 changes: 53 additions & 0 deletions .github/ISSUE_TEMPLATE/defect.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
---
name: Defect
description: Report a defect, such as a bug or regression.
labels:
- defect
body:
- type: textarea
id: observed
attributes:
label: Observed behavior
description: Describe the unexpected behavior or performance regression you are observing.
validations:
required: true
- type: textarea
id: expected
attributes:
label: Expected behavior
description: Describe the expected behavior or performance characteristics.
validations:
required: true
- type: textarea
id: environment
attributes:
label: Host environment
description: |-
Specify any relevant details about the host environment,
such as version/commit used, operating system, CPU architecture, container runtime, etc.
validations:
required: false
- type: textarea
id: configuration
attributes:
label: Guest configuration
description: |-
Specify any relevant details about the guest configuration,
such as kernel version, external dependencies version, initramfs details, lambdo config file, etc.
validations:
required: false
- type: textarea
id: steps
attributes:
label: Steps to reproduce
description: Provide as many concrete steps to reproduce the defect.
validations:
required: false
- type: textarea
id: details
attributes:
label: Other details
description: Provide as many details or other information that may be relevant to the defect.
validations:
required: false

39 changes: 39 additions & 0 deletions .github/ISSUE_TEMPLATE/proposal.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
---
name: Proposal
description: Propose an enhancement or new feature.
labels:
- proposal
body:
- type: textarea
id: change
attributes:
label: Proposed change
description: |-
This could be a behavior change, enhanced API, or a new feature.
Be explicit about the changes intended and how they will address the problem.
You can include code snippets, architectural diagrams, or any other relevant information.
validations:
required: true
- type: textarea
id: usecase
attributes:
label: Use case
description: What is the use case or general motivation for this proposal?
validations:
required: true
- type: textarea
id: contribute
attributes:
label: Contribution
description: |-
Are you intending or interested in contributing code for this proposal if accepted?
If so, please indicate what you are interested in contributing.
validations:
required: false
- type: textarea
id: details
attributes:
label: Other details
description: Provide as many details or other information that may be relevant to the proposal.
validations:
required: false