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

[docs] Add Issue templates #10

Merged
merged 6 commits into from
Jan 15, 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
59 changes: 59 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,59 @@
name: 🎯 Bug report
description: Report a bug to help us improve Deckhouse
labels:
- 'type/bug'
- 'status/needs-triage'
body:
- type: markdown
attributes:
value: |
Thank you for submitting a bug report!

Please fill out the template below to make it easier to debug your problem.
- type: checkboxes
attributes:
label: Preflight Checklist
description: Please ensure you've completed all of the following.
options:
- label: I agree to follow the [Code of Conduct](https://github.com/deckhouse/deckhouse/blob/main/CODE_OF_CONDUCT.md) that this project adheres to.
required: true
- label: I have searched the [issue tracker](https://github.com/deckhouse/deckhouse/issues) for an issue that matches the one I want to file, without success.
required: true
- type: input
attributes:
label: Version
description: |
What version of Deckhouse are you running?
placeholder: v1.0.0
validations:
required: true
- type: textarea
attributes:
label: Expected Behavior
description: A clear and concise description of what you expected to happen.
validations:
required: true
- type: textarea
attributes:
label: Actual Behavior
description: A clear description of what actually happens.
validations:
required: true
- type: textarea
attributes:
label: Steps To Reproduce
description: Steps to reproduce the behavior if it is not self-explanatory.
placeholder: |
1. In this environment...
2. With this config...
3. Run '...'
4. See error...
- type: textarea
attributes:
label: Additional Information
description: Links? References? Anything that will give us more context about the issue that you are encountering!
- type: textarea
attributes:
label: Logs
description: Deckhouse application logs (if relevant).
render: shell
17 changes: 17 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
blank_issues_enabled: false
contact_links:
- name: 📚 Documentation
url: https://deckhouse.io/documentation/
about: Check the documentation for help

- name: 🤔 Ask a question
url: https://github.com/deckhouse/deckhouse/discussions/new?category=q-a
about: Ask and discuss questions with other community members

- name: 💬 Telegram channel [EN]
url: https://t.me/deckhouse
about: Please ask and answer questions here

- name: 🇷🇺 Telegram channel [RU]
url: https://t.me/deckhouse_ru
about: Please ask and answer questions here
37 changes: 37 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
name: 💡 Feature request
description: Suggest an idea for Deckhouse
labels:
- 'type/enhancement'
- 'status/needs-triage'
body:
- type: markdown
attributes:
value: |
Thank you for submitting a feature request!

Please describe what you would like to change/add and why in detail by filling out the template below.
- type: checkboxes
attributes:
label: Preflight Checklist
description: Please ensure you've completed all of the following.
options:
- label: I agree to follow the [Code of Conduct](https://github.com/deckhouse/deckhouse/blob/main/CODE_OF_CONDUCT.md) that this project adheres to.
required: true
- label: I have searched the [issue tracker](https://github.com/deckhouse/deckhouse/issues) for an issue that matches the one I want to file, without success.
required: true
- type: textarea
attributes:
label: Use case. Why is this important?
description: A clear and concise description of the problem you are seeking to solve with this feature request.
validations:
required: true
- type: textarea
attributes:
label: Proposed Solution
description: A clear and concise description of what would you like to happen.
validations:
required: true
- type: textarea
attributes:
label: Additional Information
description: Add any other context about the problem here.