Skip to content

Commit

Permalink
docs(github): Issue templates
Browse files Browse the repository at this point in the history
  • Loading branch information
RezaRahemtola committed Dec 12, 2024
1 parent 5c1a13e commit 9c3e344
Show file tree
Hide file tree
Showing 2 changed files with 107 additions and 0 deletions.
71 changes: 71 additions & 0 deletions .github/ISSUE_TEMPLATE/bug-report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,71 @@
name: Bug Report
description: File a bug report
title: "[Bug]: "
labels: ["bug", "triage"]
assignees:
- RezaRahemtola
body:
- type: markdown
attributes:
value: |
Thanks for taking the time to fill out this bug report!
- type: textarea
id: description
attributes:
label: Description
description: Describe your bug shortly.
placeholder: Tell us what you see!
value: "A bug happened!"
validations:
required: true
- type: textarea
id: what-happened
attributes:
label: What happened?
description: Describe your bug with as much details as possible.
placeholder: Tell us what you see!
value: "A bug happened!"
validations:
required: true
- type: textarea
id: expected-behaviour
attributes:
label: Expected behaviour
description: Describe what should happened with as much details as possible.
placeholder: Tell us what should happened!
value: "This should happened!"
validations:
required: true
- type: textarea
id: environment
attributes:
label: Environment
description: Describe your environment with as much details as possible.
placeholder: Tell us what is your environment!
value: "- OS and its version\n- Version of the framework / libertai-client if used\n- Version of Python of your project"
validations:
required: true
- type: textarea
id: steps-to-reproduce
attributes:
label: Steps to reproduce
description: List the steps to reproduce with as much details as possible.
placeholder: Tell us how to reproduce this bug!
value: "- You have to do this!\n- Then this!"
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: C++
validations:
required: false
- type: textarea
id: proposed-solution
attributes:
label: Proposed solution
description: If you have an idea of how to fix this issue, please write it down here, so we can begin discussing it.
validations:
required: false
36 changes: 36 additions & 0 deletions .github/ISSUE_TEMPLATE/feature-request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
name: Feature Request
description: File a feature request
title: "[Feature]: "
labels: ["feature", "triage"]
assignees:
- RezaRahemtola
body:
- type: markdown
attributes:
value: |
Thanks for taking the time to fill out this feature request!
- type: textarea
id: description
attributes:
label: Description
description: Describe your feature shortly.
placeholder: Tell us what you want to see!
value: "A new feature!"
validations:
required: true
- type: textarea
id: expected-behaviour
attributes:
label: Expected behaviour
description: Describe what you want to happen with as much details as possible.
placeholder: Tell us what you want to happen!
value: "This should happened!"
validations:
required: true
- type: textarea
id: proposed-solution
attributes:
label: Proposed solution
description: If you have an idea of how to realise this feature, please write it down here, so we can begin discussing it.
validations:
required: false

0 comments on commit 9c3e344

Please sign in to comment.