mirror of
https://github.com/jrnl-org/jrnl.git
synced 2025-05-10 08:38:32 +02:00
Update issue templates from markdown into yaml forms (#1567)
* convert bug report from markdown to yaml * convert feature request from markdown to yaml * convert documentation template from markdown to yaml * convert support request template from markdown to yaml
This commit is contained in:
parent
11119a6143
commit
fbb819d7a0
8 changed files with 212 additions and 144 deletions
42
.github/ISSUE_TEMPLATE/bug_report.md
vendored
42
.github/ISSUE_TEMPLATE/bug_report.md
vendored
|
@ -1,42 +0,0 @@
|
|||
---
|
||||
name: Bug report
|
||||
about: Create a report to help us improve
|
||||
title: ''
|
||||
labels: ":new:, bug"
|
||||
assignees: ''
|
||||
|
||||
---
|
||||
|
||||
## Bug Report
|
||||
<!--
|
||||
Hello, and thank you for reporting an issue!
|
||||
Please fill out the points below, as it will make our process much easier.
|
||||
-->
|
||||
|
||||
<!-- Please tell us about your environment -->
|
||||
### Environment
|
||||
- `jrnl --diagnostic` output: <!-- Run the command and paste the output here -->
|
||||
- Install method: <!-- How did you install jrnl? (pipx, brew, etc) -->
|
||||
|
||||
### Current Behavior
|
||||
<!--
|
||||
Please put a short description of what is currently happening.
|
||||
-->
|
||||
|
||||
### Expected Behavior
|
||||
<!--
|
||||
Please write a short description of what you would expect to happen
|
||||
(instead of what is currently happening).
|
||||
-->
|
||||
|
||||
### Repro Steps
|
||||
<!--
|
||||
Please provide the steps to reproduce the problem. It is important for you to
|
||||
be as precise as possible here, since more info will let us help you faster.
|
||||
If applicable, please run jrnl with --debug and paste the output.
|
||||
-->
|
||||
|
||||
### Other Information
|
||||
<!-- (e.g. more detailed explanation, stacktraces, related
|
||||
issues, suggestions how to fix, links for us to have context, eg.
|
||||
stackoverflow, gitter, etc) -->
|
74
.github/ISSUE_TEMPLATE/bug_report.yaml
vendored
Normal file
74
.github/ISSUE_TEMPLATE/bug_report.yaml
vendored
Normal file
|
@ -0,0 +1,74 @@
|
|||
name: Bug Report
|
||||
description: Create a report to help us improve
|
||||
title: "Bug Report"
|
||||
labels: [ ":new:", "bug" ]
|
||||
body:
|
||||
- type: markdown
|
||||
attributes:
|
||||
value: |
|
||||
# Bug Report
|
||||
Hello, and thank you for reporting an issue!
|
||||
|
||||
Please fill out the points below, as it will make our process much easier.
|
||||
|
||||
- type: textarea
|
||||
id: diagnostic
|
||||
attributes:
|
||||
label: Diagnostic output
|
||||
description: Run `jrnl --diagnostic` and paste the output below
|
||||
placeholder: Paste output here
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: textarea
|
||||
id: current-behavior
|
||||
attributes:
|
||||
label: Current Behavior
|
||||
description: Please put a short description of what is currently happening.
|
||||
placeholder: Tell us what is happening
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: textarea
|
||||
id: expected-behavior
|
||||
attributes:
|
||||
label: Expected Behavior
|
||||
description: Please write a short description of what you would expect to happen
|
||||
placeholder: Tell us what should be happening
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: textarea
|
||||
id: repro-steps
|
||||
attributes:
|
||||
label: Repro Steps
|
||||
description: |
|
||||
Provide the steps to reproduce the problem.
|
||||
|
||||
Please be as precise as possible, since more info will let us help you faster.
|
||||
placeholder: Repro steps
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: textarea
|
||||
id: debug-output
|
||||
attributes:
|
||||
label: Debug output
|
||||
description: |
|
||||
Please provide the output of your command with the `--debug` flag on.
|
||||
placeholder: "example: `jrnl --debug lorem ipsum`"
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: textarea
|
||||
id: other-info
|
||||
attributes:
|
||||
label: Other Information
|
||||
description: >
|
||||
Is there anything else we should know?
|
||||
|
||||
(e.g. more detailed explanation, stacktraces, related
|
||||
issues, suggestions how to fix, links for us to have context, eg.
|
||||
stackoverflow, gitter, etc)
|
||||
validations:
|
||||
required: false
|
31
.github/ISSUE_TEMPLATE/documentation.md
vendored
31
.github/ISSUE_TEMPLATE/documentation.md
vendored
|
@ -1,31 +0,0 @@
|
|||
---
|
||||
name: Documentation Change
|
||||
about: Request or report any updates to our documentation (https://jrnl.sh)
|
||||
title: ''
|
||||
labels: ":new:, documentation"
|
||||
assignees: ''
|
||||
|
||||
---
|
||||
|
||||
## Documentation Change
|
||||
<!--
|
||||
Hello, and thank you for reporting an issue!
|
||||
Please fill out the points below, as it will make our process much easier.
|
||||
-->
|
||||
|
||||
### Affected Page(s)
|
||||
<!--
|
||||
Please tell us which page, or pages, from the documentation site (https://jrnl.sh) are
|
||||
affected in this issue
|
||||
-->
|
||||
- <!-- example: https://jrnl.sh/en/stable/overview -->
|
||||
|
||||
### What Could Be Better?
|
||||
<!--
|
||||
Please write a short description of what you hope can be clarified or further explained.
|
||||
-->
|
||||
|
||||
### Other Information
|
||||
<!--
|
||||
Is there anything else we should know that might be helpful?
|
||||
-->
|
41
.github/ISSUE_TEMPLATE/documentation.yaml
vendored
Normal file
41
.github/ISSUE_TEMPLATE/documentation.yaml
vendored
Normal file
|
@ -0,0 +1,41 @@
|
|||
name: Documentation Change
|
||||
description: Request or report any updates to our documentation (https://jrnl.sh)
|
||||
title: Documentation Change
|
||||
labels: [ ":new:", "documentation" ]
|
||||
body:
|
||||
- type: markdown
|
||||
attributes:
|
||||
value: |
|
||||
# Documentation Change
|
||||
Hello, and thank you for reporting an issue!
|
||||
|
||||
Please fill out the points below, as it will make our process much easier.
|
||||
|
||||
- type: textarea
|
||||
id: affected-pages
|
||||
attributes:
|
||||
label: Affected Page(s)
|
||||
description: >
|
||||
Please tell us which page, or pages, from the documentation site
|
||||
(https://jrnl.sh) are affected in this issue
|
||||
placeholder: "example: https://jrnl.sh/en/stable/overview"
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: textarea
|
||||
id: what-could-be-better
|
||||
attributes:
|
||||
label: What Could Be Better?
|
||||
description: >
|
||||
Please write a short description of what you hope can be clarified or
|
||||
further explained.
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: textarea
|
||||
id: other-info
|
||||
attributes:
|
||||
label: Other Information
|
||||
description: Is there anything else we should know that might be helpful?
|
||||
validations:
|
||||
required: false
|
31
.github/ISSUE_TEMPLATE/feature_request.md
vendored
31
.github/ISSUE_TEMPLATE/feature_request.md
vendored
|
@ -1,31 +0,0 @@
|
|||
---
|
||||
name: Feature request
|
||||
about: Suggest an idea for jrnl
|
||||
title: ''
|
||||
labels: ":new:, enhancement"
|
||||
assignees: ''
|
||||
|
||||
---
|
||||
|
||||
## Feature Request
|
||||
<!--
|
||||
Hello, and thank you for reporting an issue!
|
||||
Please fill out the points below, as it will make our process much easier.
|
||||
-->
|
||||
|
||||
### Use Case/Motivation
|
||||
<!--
|
||||
What is the motivation / use case for changing the behavior?
|
||||
-->
|
||||
|
||||
### Example Usage
|
||||
<!--
|
||||
Please provide examples of the usage you would like to see.
|
||||
e.g `jrnl --new-flag="super cool new feature"`
|
||||
-->
|
||||
|
||||
### Other information
|
||||
<!--
|
||||
Please provide any other relevant info about this request (e.g. stacktraces,
|
||||
related issues, suggestions how to fix, etc)
|
||||
-->
|
43
.github/ISSUE_TEMPLATE/feature_request.yaml
vendored
Normal file
43
.github/ISSUE_TEMPLATE/feature_request.yaml
vendored
Normal file
|
@ -0,0 +1,43 @@
|
|||
name: Feature Report
|
||||
description: Suggest an idea for jrnl
|
||||
title: "Feature Report"
|
||||
labels: [ ":new:", "enhancement" ]
|
||||
body:
|
||||
- type: markdown
|
||||
attributes:
|
||||
value: |
|
||||
# Feature Request
|
||||
Hello, and thank you for reporting an issue!
|
||||
|
||||
Please fill out the points below, as it will make our process much easier.
|
||||
|
||||
- type: textarea
|
||||
id: user-case
|
||||
attributes:
|
||||
label: Use Case/Motivation
|
||||
description: What is the motivation / use case for changing the behavior?
|
||||
placeholder: Tell us about your idea
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: textarea
|
||||
id: example-usage
|
||||
attributes:
|
||||
label: Example Usage
|
||||
description: Please provide examples of the usage you would like to see.
|
||||
placeholder: e.g `jrnl --new-flag="super cool new feature"`
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: textarea
|
||||
id: other-info
|
||||
attributes:
|
||||
label: Other Information
|
||||
description: >
|
||||
Is there anything else we should know?
|
||||
|
||||
(e.g. more detailed explanation, stacktraces, related
|
||||
issues, suggestions how to fix, links for us to have context, eg.
|
||||
stackoverflow, gitter, etc)
|
||||
validations:
|
||||
required: false
|
40
.github/ISSUE_TEMPLATE/support_request.md
vendored
40
.github/ISSUE_TEMPLATE/support_request.md
vendored
|
@ -1,40 +0,0 @@
|
|||
---
|
||||
name: Support Request
|
||||
about: Get help with jrnl
|
||||
title: ''
|
||||
labels: ":new:, support"
|
||||
assignees: ''
|
||||
|
||||
---
|
||||
|
||||
## Support Request
|
||||
<!--
|
||||
Hello, and thank you for reporting an issue!
|
||||
Please fill out the points below, as it will make our process much easier.
|
||||
-->
|
||||
|
||||
### Environment
|
||||
<!--
|
||||
Please tell us about your environment
|
||||
-->
|
||||
- Jrnl `--diagnostic` output: <!-- Run `jrnl --diagnostic` and paste the output -->
|
||||
- Install method: <!-- How did you install jrnl? (pipx, brew, etc) -->
|
||||
|
||||
### What are you trying to do?
|
||||
<!--
|
||||
Please write a short description of what is happening.
|
||||
-->
|
||||
|
||||
### What have you tried?
|
||||
<!--
|
||||
Have you tried anything to fix the problem? This can help give us more
|
||||
information to help you with.
|
||||
-->
|
||||
|
||||
### Other Information
|
||||
<!--
|
||||
If applicable, please run jrnl with --debug and paste the output.
|
||||
|
||||
Is there anything else we should know that might be helpful?
|
||||
e.g. detailed explanation, stacktraces, related issues, suggestions how to fix
|
||||
-->
|
54
.github/ISSUE_TEMPLATE/support_request.yaml
vendored
Normal file
54
.github/ISSUE_TEMPLATE/support_request.yaml
vendored
Normal file
|
@ -0,0 +1,54 @@
|
|||
name: Support Request
|
||||
description: Get help with jrnl
|
||||
title: Support Request
|
||||
labels: [ ":new:", "support" ]
|
||||
body:
|
||||
- type: markdown
|
||||
attributes:
|
||||
value: |
|
||||
# Support Request
|
||||
Hello, and thank you for reporting an issue!
|
||||
|
||||
Please fill out the points below, as it will make our process much easier.
|
||||
|
||||
- type: textarea
|
||||
id: diagnostic
|
||||
attributes:
|
||||
label: Diagnostic output
|
||||
description: Run `jrnl --diagnostic` and paste the output below
|
||||
placeholder: Paste output here
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: textarea
|
||||
id: current-behavior
|
||||
attributes:
|
||||
label: What are you trying to do?
|
||||
description: Please put a short description of what is happening.
|
||||
placeholder: Tell us what is happening
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: textarea
|
||||
id: tried
|
||||
attributes:
|
||||
label: What have you tried?
|
||||
description: >
|
||||
Have you tried anything to fix the problem? This can help give us more
|
||||
information to help you with.
|
||||
placeholder: Tell us what should be happening
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: textarea
|
||||
id: other-info
|
||||
attributes:
|
||||
label: Other Information
|
||||
description: >
|
||||
Is there anything else we should know?
|
||||
|
||||
(e.g. more detailed explanation, stacktraces, related
|
||||
issues, suggestions how to fix, links for us to have context, eg.
|
||||
stackoverflow, gitter, etc)
|
||||
validations:
|
||||
required: false
|
Loading…
Add table
Reference in a new issue