1
1
mirror of https://github.com/orhun/git-cliff.git synced 2024-09-11 06:55:38 +03:00

chore(github): use form based issue templates (#529)

This commit is contained in:
Jeroen Claassens 2024-03-04 13:38:14 +01:00 committed by GitHub
parent d7689625ad
commit 8f8e221563
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
6 changed files with 186 additions and 107 deletions

View File

@ -1,41 +0,0 @@
---
name: Bug report 🐛
about: Report a bug to help us improve
title: ""
labels: "bug"
assignees: "orhun"
---
**Describe the bug**
<!--- A clear and concise description of what the bug is. -->
**To reproduce**
<!---
Steps to reproduce the behavior:
1. Build with '...' arguments
2. Run with '....' arguments
4. Use '...' configuration options
5. See the error
-->
**Expected behavior**
<!--- A clear and concise description of what you expected to happen. -->
**Screenshots / Logs**
<!--- If applicable, add screenshots to help explain your problem. -->
**Software information**
<!--- Please fill in following fields -->
- Operating system: <!--- e.g. Arch GNU/Linux x86_64 6.2.1-arch1-1 -->
- Rust version: <!--- e.g. rustc 1.69.0-nightly (7281249a1 2023-02-27) -->
- Project version: <!--- e.g. 0.1.0 -->
**Additional context**
<!--- Add any other context about the problem here. -->

69
.github/ISSUE_TEMPLATE/bug_report.yml vendored Normal file
View File

@ -0,0 +1,69 @@
name: Bug report 🐛
description: Report a bug to help us improve
labels: ['bug']
assignees:
- orhun
body:
- type: markdown
attributes:
value: |
Thanks for taking the time to fill out this bug report!
- type: checkboxes
id: new-bug
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
id: bug-description
attributes:
label: Description of the bug
description: Tell us what bug you encountered and what should have happened
validations:
required: true
- type: textarea
id: steps-to-reproduce
attributes:
label: Steps To Reproduce
description: Steps to reproduce the behavior.
placeholder: |
Please tell us how to reproduce this bug, for example:
1. Build with '...' arguments
2. Run with '....' arguments
4. Use '...' configuration options
5. See the error
validations:
required: true
- type: textarea
id: expected-behavior
attributes:
label: Expected behavior
description: What should be the expected behavior.
placeholder: A clear and concise description of what you expected to happen.
validations:
required: true
- type: textarea
id: screenshots
attributes:
label: Screenshots / Logs
description: If applicable, add screenshots to help explain your problem.
placeholder: Paste your screenshots here.
- type: textarea
id: software-info
attributes:
label: Software information
description: Please provide the following information about your environment.
value: |
- Operating system:
- Rust version:
- Project version:
validations:
required: true
- type: textarea
id: additional-context
attributes:
label: Additional context
description: Do you want to share any additional context about this bug?
placeholder: Add any other context about the problem here.

View File

@ -1,23 +0,0 @@
---
name: Feature request ⛰️
about: Make a suggestion for the project
title: ""
labels: "feature/request"
assignees: "orhun"
---
**Is your feature request related to a problem? Please describe.**
<!--- A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] -->
**Describe the solution you'd like**
<!--- A clear and concise description of what you want to happen. -->
**Describe alternatives you've considered**
<!--- A clear and concise description of any alternative solutions or features you've considered. -->
**Additional context**
<!--- Add any other context or screenshots about the feature request here. -->

View File

@ -0,0 +1,47 @@
name: Feature request ⛰️
description: Suggest an idea for this project
labels: ['feature/request']
assignees:
- orhun
body:
- type: markdown
attributes:
value: Thank you for suggesting this feature! The more information you provide, the more likely it is that it will be picked up.
- type: checkboxes
id: new-feature
attributes:
label: Is there an existing issue or pull request for this?
description: Please search to see if an issue or pull request already exists for the feature you desire.
options:
- label: I have searched the existing issues and pull requests
required: true
- type: textarea
id: feature-description
attributes:
label: Feature description
description: Is your feature request related to a problem? Please describe.
placeholder: A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
validations:
required: true
- type: textarea
id: desired-solution
attributes:
label: Desired solution
description: Describe the solution you'd like
placeholder: A clear and concise description of what you want to happen.
validations:
required: true
- type: textarea
id: alternatives-considered
attributes:
label: Alternatives considered
description: Describe alternatives you've considered
placeholder: A clear and concise description of any alternative solutions or features you've considered.
validations:
required: true
- type: textarea
id: additional-context
attributes:
label: Additional context
description: Do you want to share any additional context about this bug?
placeholder: Add any other context about the problem here.

View File

@ -1,43 +0,0 @@
---
name: GitHub Integration ⚙️
about: Report a bug or request a feature about GitHub integration
title: ""
labels: ["github_integration"]
assignees: "orhun"
---
<!--- Please see https://git-cliff.org/docs/integration/github -->
**Describe the issue**
<!--- A clear and concise description of what the issue is. -->
**To reproduce**
<!---
Steps to reproduce the behavior:
1. Build with '...' arguments
2. Run with '....' arguments
4. Use '...' configuration options
5. See the error
-->
**Expected behavior**
<!--- A clear and concise description of what you expected to happen. -->
**Screenshots / Logs**
<!--- If applicable, add screenshots to help explain your problem. -->
**Software information**
<!--- Please fill in following fields -->
- Operating system: <!--- e.g. Arch GNU/Linux x86_64 6.2.1-arch1-1 -->
- Rust version: <!--- e.g. rustc 1.69.0-nightly (7281249a1 2023-02-27) -->
- Project version: <!--- e.g. 0.1.0 -->
**Additional context**
<!--- Add any other context about the problem here. -->

View File

@ -0,0 +1,70 @@
name: GitHub Integration ⚙️
description: Report a bug or request a feature about GitHub integration
labels: ['github_integration']
assignees:
- orhun
body:
- type: markdown
attributes:
value: |
Thanks for taking the time to fill out this bug report!
Please see https://git-cliff.org/docs/integration/github for more information about GitHub integration.
- type: checkboxes
id: new-bug
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
id: bug-description
attributes:
label: Description of the bug
description: Tell us what bug you encountered and what should have happened
validations:
required: true
- type: textarea
id: steps-to-reproduce
attributes:
label: Steps To Reproduce
description: Steps to reproduce the behavior.
placeholder: |
Please tell us how to reproduce this bug, for example:
1. Build with '...' arguments
2. Run with '....' arguments
4. Use '...' configuration options
5. See the error
validations:
required: true
- type: textarea
id: expected-behavior
attributes:
label: Expected behavior
description: What should be the expected behavior.
placeholder: A clear and concise description of what you expected to happen.
validations:
required: true
- type: textarea
id: screenshots
attributes:
label: Screenshots / Logs
description: If applicable, add screenshots to help explain your problem.
placeholder: Paste your screenshots here.
- type: textarea
id: software-info
attributes:
label: Software information
description: Please provide the following information about your environment.
value: |
- Operating system:
- Rust version:
- Project version:
validations:
required: true
- type: textarea
id: additional-context
attributes:
label: Additional context
description: Do you want to share any additional context about this bug?
placeholder: Add any other context about the problem here.