chore: add github issue form bug and feat templates
This commit is contained in:
parent
e37aa98616
commit
b7f04a114b
28
.github/ISSUE_TEMPLATE/bug_report.md
vendored
28
.github/ISSUE_TEMPLATE/bug_report.md
vendored
|
@ -1,28 +0,0 @@
|
|||
---
|
||||
name: Bug report
|
||||
about: Let us know about a bug in Espanso
|
||||
title: ''
|
||||
labels: bug
|
||||
assignees: ''
|
||||
|
||||
---
|
||||
|
||||
**Describe the bug**
|
||||
A clear and concise description of what the bug is
|
||||
|
||||
**To Reproduce**
|
||||
Steps to reproduce the behavior:
|
||||
1.
|
||||
|
||||
**Expected behavior**
|
||||
A clear and concise description of what you expected to happen.
|
||||
|
||||
**Screenshots**
|
||||
If applicable, add screenshots or screen recordings to help explain your problem.
|
||||
|
||||
**Logs**
|
||||
If possible, run `espanso log` in a terminal after the bug has occurred, then post the output here so that we can better diagnose the problem
|
||||
|
||||
**Setup information**
|
||||
- OS: What OS are you using?
|
||||
- Version: which version of Espanso are you running? (you can find out by running `espanso --version` inside a terminal)
|
62
.github/ISSUE_TEMPLATE/bug_report.yml
vendored
Normal file
62
.github/ISSUE_TEMPLATE/bug_report.yml
vendored
Normal file
|
@ -0,0 +1,62 @@
|
|||
name: 🐛 Bug Report
|
||||
description: Let us know about a bug in Espanso
|
||||
labels: [bug, 'status: needs triage']
|
||||
body:
|
||||
- type: textarea
|
||||
attributes:
|
||||
label: Description
|
||||
description: A clear and concise description of what the bug is.
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: textarea
|
||||
attributes:
|
||||
label: Steps to reproduce
|
||||
description: Write down the steps to reproduce the bug.
|
||||
placeholder: |
|
||||
1. Step 1...
|
||||
2. Step 2...
|
||||
3. Step 3...
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: textarea
|
||||
attributes:
|
||||
label: Expected behavior
|
||||
description: |
|
||||
A clear and concise description of what you expected to happen. It's fine if you're not sure your understanding is correct.
|
||||
placeholder: Write what you thought would happen.
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: textarea
|
||||
attributes:
|
||||
label: Screenshots
|
||||
description: |
|
||||
If applicable, add screenshots or screen recordings to help explain your problem.
|
||||
|
||||
- type: textarea
|
||||
attributes:
|
||||
label: Logs
|
||||
description: |
|
||||
If possible, run `espanso log` in a terminal after the bug has occurred, then post the output here so that we can better diagnose the problem
|
||||
|
||||
- type: textarea
|
||||
attributes:
|
||||
label: Your environment
|
||||
description: Tell us about your enviornment and which version of Espanso you are running (you can find out by running `espanso --version` inside a terminal).
|
||||
value: |
|
||||
- Public source code:
|
||||
- Environment name and version (e.g., Rust 1.59.0):
|
||||
- Operating system and version (e.g., Ubuntu 20.04.2 LTS):
|
||||
- Espanso version (e.g., 2.1.4-beta):
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: checkboxes
|
||||
attributes:
|
||||
label: Self-service
|
||||
description: |
|
||||
If you feel like you could contribute to this issue, please check the box below. This would tell us and other people looking for contributions that someone's working on it.
|
||||
options:
|
||||
- label: I'd be willing to fix this bug myself.
|
8
.github/ISSUE_TEMPLATE/config.yml
vendored
Normal file
8
.github/ISSUE_TEMPLATE/config.yml
vendored
Normal file
|
@ -0,0 +1,8 @@
|
|||
blank_issues_enabled: false
|
||||
contact_links:
|
||||
- name: 📖 Espanso Documentation
|
||||
url: https://espanso.org/docs/
|
||||
about: Our Espanso documentation shows you how to configure matches, use packages and much more.
|
||||
- name: ❓ Reddit
|
||||
url: https://www.reddit.com/r/espanso/
|
||||
about: Our official Reddit community in which you can ask questions and receive updates on espanso.
|
20
.github/ISSUE_TEMPLATE/feature_request.md
vendored
20
.github/ISSUE_TEMPLATE/feature_request.md
vendored
|
@ -1,20 +0,0 @@
|
|||
---
|
||||
name: Feature request
|
||||
about: Suggest an idea to make Espanso better
|
||||
title: ''
|
||||
labels: ''
|
||||
assignees: ''
|
||||
|
||||
---
|
||||
|
||||
**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.
|
32
.github/ISSUE_TEMPLATE/feature_request.yml
vendored
Normal file
32
.github/ISSUE_TEMPLATE/feature_request.yml
vendored
Normal file
|
@ -0,0 +1,32 @@
|
|||
name: 🚀 Feature Request / RFC
|
||||
description: Suggest an idea to make Espanso better
|
||||
labels: [feature, "status: needs triage"]
|
||||
body:
|
||||
- type: textarea
|
||||
attributes:
|
||||
label: Description
|
||||
description: A clear and concise description of what the feature is. Feel free to include any screenshots, API design, or other contextual information.
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: textarea
|
||||
attributes:
|
||||
label: Motivation
|
||||
description: Please outline the motivation for the proposal and why it should be implemented.
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: textarea
|
||||
attributes:
|
||||
label: Alternatives
|
||||
description: A clear and concise description of any alternative solutions or features you've considered.
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: checkboxes
|
||||
attributes:
|
||||
label: Have you tried building it? Or would you like it?
|
||||
description: |
|
||||
If you feel like you could contribute directly to Espanso, please check the box below. This would tell us and other people looking for contributions that someone's working on it.
|
||||
options:
|
||||
- label: I'd be willing to contribute this feature to Espanso myself.
|
Loading…
Reference in New Issue
Block a user