Skip to content

Add issue templates #68

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

Merged
merged 2 commits into from
Feb 23, 2024
Merged
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
52 changes: 52 additions & 0 deletions .github/ISSUE_TEMPLATE/bug.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
name: Bug
description: Report an issue with the library
title: 'Bug: <title>'
labels:
- bug
assignees:
- OptimumCode
body:
- type: checkboxes
attributes:
label: Is there an existing issue for this?
description: Please search to see if an issue already exists for the bug you encountered.
options:
- label: I have searched the existing issues
required: true
- type: textarea
attributes:
label: Current Behavior
description: A concise description of what you're experiencing.
validations:
required: false
- type: textarea
attributes:
label: Expected Behavior
description: A concise description of what you expected to happen.
validations:
required: false
- type: textarea
attributes:
label: JSON schema
description: A JSON schema that results in the observed behavior
placeholder: |
{}
render: json
validations:
required: false
- type: input
attributes:
label: Library version
description: Version of the library that you used when experienced the problem
placeholder: '0.0.1'
validations:
required: true
- type: textarea
attributes:
label: Anything else?
description: |
Links? References? Anything that will give us more context about the issue you are encountering!

Tip: You can attach images or log files by clicking this area to highlight it and then dragging files in.
validations:
required: false
21 changes: 21 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
name: Feature request
description: Enhancement proposal for the library
title: 'Enhancement: <title>'
labels:
- enhancement
assignees:
- OptimumCode
body:
- type: checkboxes
attributes:
label: Is there an existing issue for this?
description: Please search to see if a similar proposal already exists.
options:
- label: I have searched the existing issues
required: true
- type: textarea
attributes:
label: Enhancement description
description: A description of what would like to add/change in the library.
validations:
required: true
37 changes: 37 additions & 0 deletions .github/ISSUE_TEMPLATE/question.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
name: Question
description: Ask a question about the library or about its behavior in certain cases
title: 'Question: <title>'
labels:
- question
assignees:
- OptimumCode
body:
- type: checkboxes
attributes:
label: Is there an existing issue for this?
description: Please search to see if a similar question already exists for the one you would like to ask.
options:
- label: I have searched the existing issues
required: true
- type: textarea
attributes:
label: Question
description: What would you like to know?
validations:
required: false
- type: input
attributes:
label: Library version
description: Version of the library that you use right now
placeholder: '0.0.1'
validations:
required: false
- type: textarea
attributes:
label: Anything else?
description: |
Links? References? Examples? Anything else that will help to properly respond to your question!

Tip: You can attach images or log files by clicking this area to highlight it and then dragging files in.
validations:
required: false