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

Improve issue templates #17

Merged
merged 2 commits into from
Sep 6, 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
36 changes: 0 additions & 36 deletions .github/ISSUE_TEMPLATE/bug_report.md

This file was deleted.

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: Create a report to help us improve
title: "[BUG] "
labels: ["bug", "triage"]
body:
- type: markdown
attributes:
value: |
Would you like to help us improve Bifröst? That would be great! 🙂

Please also check out [our 💬 Discussions](https://github.com/engity-com/bifroest/discussions) if you are looking for best practices, discussing new ideas, or if your configuration is not working as expected.

- type: textarea
id: version-bifroest
attributes:
label: Bifröst's Version
description: Paste here the output of `bifroest version`.
placeholder: Output of `bifroest version`
render: text
validations:
required: true

- type: textarea
id: version-client
attributes:
label: Client's Version
description: Paste here output's first line of `ssh -v localhost`.
placeholder: Output's first line of of `ssh -v localhost`
render: text
validations:
required: true

- type: textarea
id: description
attributes:
label: Bug description
description: A clear and concise description of what the bug is.
validations:
required: true

- type: textarea
id: steps-to-reproduce
attributes:
label: Steps to reproduce
description: If applicable, add screenshots to help explain your problem.
placeholder: |
1. Connected to '...'
2. Executed '...'
3. See error
validations:
required: true

- type: textarea
id: expected-behavior
attributes:
label: Expected behavior
description: A clear and concise description of what you expected to happen.
validations:
required: true

- type: textarea
id: notes
attributes:
label: Additional context
description: Add any other context about the problem here.
validations:
required: false

- type: markdown
attributes:
value: Thank you for your contribution. 🙏
3 changes: 3 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
blank_issues_enabled: false
contact_links:
- name: Discussions
url: https://github.com/engity-com/bifroest/discussions
about: Maybe you just want to know how something works and what are best practises? Please try out our discussions.
- name: Contact to Engity
url: https://engity.com/contact
about: Please send us direct contact requests here.
21 changes: 0 additions & 21 deletions .github/ISSUE_TEMPLATE/feature_request.md

This file was deleted.

48 changes: 48 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
name: "🚀 Feature request"
description: Suggest an idea for this project
title: "[FEATURE] "
labels: ["feature_request", "triage"]
body:
- type: markdown
attributes:
value: |
Would you like to help us improve Bifröst? That would be great! 🙂

Please also check out [our 💬 Discussions](https://github.com/engity-com/bifroest/discussions) if you are looking for best practices, discussing new ideas, or if your configuration is not working as expected.

- type: textarea
id: problem-relation
attributes:
label: Is your feature request related to a problem?
description: A clear and concise description of what the problem is.
placeholder: Ex. I'm always frustrated when [...]
validations:
required: true

- type: textarea
id: proposal
attributes:
label: Describe the solution you'd like.
description: A clear and concise description of what you want to happen.
validations:
required: true

- type: textarea
id: alternatives
attributes:
label: Describe alternatives you've considered
description: A clear and concise description of any alternative solutions or features you've considered.
validations:
required: true

- type: textarea
id: notes
attributes:
label: Additional context
description: Add any other context or screenshots about the feature request here.
validations:
required: false

- type: markdown
attributes:
value: Thank you for your contribution. 🙏
Original file line number Diff line number Diff line change
@@ -1,13 +1,5 @@
---
name: Pull Request
about: Provide us new changes, made by you.
title: ''
labels: 'triage'
assignees: ''
---

## References
* Issue(s): <!-- e.g. #123 -->
* Issue(s): <!-- e.g. #123 -->

## Motivation
<!-- Please shortly describe your motivation to create this PR. -->
Expand Down
Loading