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

feat: GitHub issue templates #1

Open
wants to merge 1 commit 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
1 change: 1 addition & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
blank_issues_enabled: true
37 changes: 37 additions & 0 deletions .github/ISSUE_TEMPLATE/docs-enhancement.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
name: Documentation enhancement
description: Suggest an enhancement for the documentation of KJect
labels:
- Status ✨ New
- Type ⚙️ Enhancement
body:
- type: markdown
attributes:
value: |
Thank you for taking the time to suggest an enhancement to us.
Please fill out the following form to help us understand your suggestion.
- type: input
id: link
attributes:
label: Link
description: The link to the page where the enhancement should be (leave empty if you suggest a new page).
- type: textarea
id: description
attributes:
label: Description
description: A clear and concise description of what you want to be added to the documentation.
validations:
required: true
- type: textarea
attributes:
label: Additional context
description: Add any other context about the problem here.
- type: checkboxes
id: checklist
attributes:
label: Checklist
description: Pleas check the following boxes if you have done the following.
options:
- label: I have search for [pull requests](https://github.com/KJect/kject.github.io/pulls) that implement this enhancement.
required: true
- label: I have searched for [issues](https://github.com/KJect/kject.github.io/issues) that already request this enhancement.
required: true
44 changes: 44 additions & 0 deletions .github/ISSUE_TEMPLATE/docs-error.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
name: Documentation error
description: Report error in the documentation to help us improve KJect
labels:
- Status ✨ New
- Type 🐛 Bug
body:
- type: markdown
attributes:
value: |
Thank you for taking the time to report a bug to us.
Please fill out the following form to help us reproduce and fix the bug.
- type: input
id: link
attributes:
label: Link
description: The link to the page where the error is.
validations:
required: true
- type: textarea
id: description
attributes:
label: Description
description: A clear and concise description of what is wrong with the documentation.
validations:
required: true
- type: textarea
id: expected
attributes:
label: Expected content
description: A clear and concise description of what you expected to be on the page.
- type: textarea
attributes:
label: Additional context
description: Add any other context about the problem here.
- type: checkboxes
id: checklist
attributes:
label: Checklist
description: Pleas check the following boxes if you have done the following.
options:
- label: I have search for [pull requests](https://github.com/KJect/kject.github.io/pulls) that might fix this issue.
required: true
- label: I have searched for [issues](https://github.com/KJect/kject.github.io/issues) that already describe this error.
required: true