feat(GitHub): update bug and feature request template (#1584)
* dev: Reusing template from Home Assistant * dev: add bug report template * fix: template * dev: change type * dev: * dev: add default labels * dev: Add default title * dev: add feature request template * remove feature request from markdown * dev: frontmatter
This commit is contained in:
parent
43fd7737f1
commit
c8fffe4ade
5 changed files with 135 additions and 78 deletions
25
.github/DISCUSSION_TEMPLATE/feature_request.yaml
vendored
Normal file
25
.github/DISCUSSION_TEMPLATE/feature_request.yaml
vendored
Normal file
|
@ -0,0 +1,25 @@
|
||||||
|
title: "[Feature] <feature-name-goes-here>"
|
||||||
|
labels: ["feature"]
|
||||||
|
|
||||||
|
body:
|
||||||
|
- type: markdown
|
||||||
|
attributes:
|
||||||
|
value: |
|
||||||
|
Please use this form to request new feature for Immich
|
||||||
|
- type: textarea
|
||||||
|
id: feature
|
||||||
|
attributes:
|
||||||
|
label: The feature
|
||||||
|
render: markdown
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
|
|
||||||
|
- type: checkboxes
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
|
attributes:
|
||||||
|
label: Platform
|
||||||
|
options:
|
||||||
|
- label: Server
|
||||||
|
- label: Web
|
||||||
|
- label: Mobile
|
46
.github/ISSUE_TEMPLATE/bug_report.md
vendored
46
.github/ISSUE_TEMPLATE/bug_report.md
vendored
|
@ -1,46 +0,0 @@
|
||||||
---
|
|
||||||
name: Bug report
|
|
||||||
about: Create a report to help us improve
|
|
||||||
title: '[BUG] <title>'
|
|
||||||
labels: bug, need triage
|
|
||||||
assignees: ''
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
<!--
|
|
||||||
Note: Please search to see if an issue already exists for the bug you encountered.
|
|
||||||
-->
|
|
||||||
|
|
||||||
|
|
||||||
**Describe the bug**
|
|
||||||
A clear and concise description of what the bug is.
|
|
||||||
|
|
||||||
**Task List**
|
|
||||||
|
|
||||||
*Please complete the task list below. We need this information to help us reproduce the bug or point out problems in your setup. You are not providing enough info may delay our effort to help you.*
|
|
||||||
|
|
||||||
- [ ] I have read thoroughly the README setup and installation instructions.
|
|
||||||
- [ ] I have included my `docker-compose` file.
|
|
||||||
- [ ] I have included my redacted `.env` file.
|
|
||||||
- [ ] I have included information on my machine, and environment.
|
|
||||||
|
|
||||||
**To Reproduce**
|
|
||||||
Steps to reproduce the behavior:
|
|
||||||
1. Go to '...'
|
|
||||||
2. Click on '....'
|
|
||||||
3. Scroll down to '....'
|
|
||||||
4. See error
|
|
||||||
|
|
||||||
**Expected behavior**
|
|
||||||
A clear and concise description of what you expected to happen.
|
|
||||||
|
|
||||||
**Screenshots**
|
|
||||||
If applicable, add screenshots to help explain your problem.
|
|
||||||
|
|
||||||
**System**
|
|
||||||
- Phone OS [iOS, Android]: `<version>`
|
|
||||||
- Server Version: `<version>`
|
|
||||||
- Mobile App Version: `<version>`
|
|
||||||
|
|
||||||
**Additional context**
|
|
||||||
Add any other context about the problem here.
|
|
100
.github/ISSUE_TEMPLATE/bug_report.yaml
vendored
Normal file
100
.github/ISSUE_TEMPLATE/bug_report.yaml
vendored
Normal file
|
@ -0,0 +1,100 @@
|
||||||
|
name: Report an issue with Immich
|
||||||
|
description: Report an issue with Immich
|
||||||
|
labels: ["bug", "need triage"]
|
||||||
|
title: "[BUG] <title>"
|
||||||
|
body:
|
||||||
|
- type: markdown
|
||||||
|
attributes:
|
||||||
|
value: |
|
||||||
|
This issue form is for reporting bugs only!
|
||||||
|
|
||||||
|
If you have a feature or enhancement request, please use the [feature request][fr] section of our [GitHub Discussions][fr].
|
||||||
|
|
||||||
|
[fr]: https://github.com/immich-app/immich/discussions/new?category=feature-request
|
||||||
|
|
||||||
|
- type: textarea
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
|
attributes:
|
||||||
|
label: The bug
|
||||||
|
description: >-
|
||||||
|
Describe the issue you are experiencing here, to communicate to the
|
||||||
|
maintainers. Tell us what you were trying to do and what happened.
|
||||||
|
|
||||||
|
Provide a clear and concise description of what the problem is.
|
||||||
|
|
||||||
|
- type: markdown
|
||||||
|
attributes:
|
||||||
|
value: |
|
||||||
|
## Environment
|
||||||
|
|
||||||
|
- type: input
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
|
attributes:
|
||||||
|
label: The OS that Immich Server is running on
|
||||||
|
placeholder: Ubuntu 22.10, Debian, Arch...etc
|
||||||
|
|
||||||
|
- type: input
|
||||||
|
id: version
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
|
attributes:
|
||||||
|
label: Version of Immich Server
|
||||||
|
placeholder: v1.0.0
|
||||||
|
|
||||||
|
- type: input
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
|
attributes:
|
||||||
|
label: Version of Immich Mobile App
|
||||||
|
placeholder: v1.0.0
|
||||||
|
|
||||||
|
- type: checkboxes
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
|
attributes:
|
||||||
|
label: Platform with the issue
|
||||||
|
options:
|
||||||
|
- label: Server
|
||||||
|
- label: Web
|
||||||
|
- label: Mobile
|
||||||
|
|
||||||
|
- type: textarea
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
|
attributes:
|
||||||
|
label: Your docker-compose.yml content
|
||||||
|
render: YAML
|
||||||
|
|
||||||
|
- type: textarea
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
|
attributes:
|
||||||
|
label: Your .env content
|
||||||
|
description: Please provide the redacted .env content of your setup
|
||||||
|
render: Shell
|
||||||
|
|
||||||
|
- type: textarea
|
||||||
|
id: repro
|
||||||
|
attributes:
|
||||||
|
label: Reproduction steps
|
||||||
|
description: "How do you trigger this bug? Please walk us through it step by step."
|
||||||
|
value: |
|
||||||
|
1.
|
||||||
|
2.
|
||||||
|
3.
|
||||||
|
...
|
||||||
|
render: bash
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
|
|
||||||
|
- type: textarea
|
||||||
|
attributes:
|
||||||
|
label: Additional information
|
||||||
|
description: >
|
||||||
|
If you have any additional information for us, use the field below.
|
||||||
|
|
||||||
|
- type: markdown
|
||||||
|
attributes:
|
||||||
|
value: Thank you for submitting the form
|
10
.github/ISSUE_TEMPLATE/config.yml
vendored
10
.github/ISSUE_TEMPLATE/config.yml
vendored
|
@ -1 +1,11 @@
|
||||||
blank_issues_enabled: false
|
blank_issues_enabled: false
|
||||||
|
contact_links:
|
||||||
|
- name: I have a question or need support
|
||||||
|
url: https://discord.gg/D8JsnBEuKb
|
||||||
|
about: We use GitHub for tracking bugs, please check out our Discord channel for freaky fast support.
|
||||||
|
- name: Feature Request
|
||||||
|
url: https://github.com/immich-app/immich/discussions/new?category=feature-request
|
||||||
|
about: Please use our GitHub Discussion for making feature requests.
|
||||||
|
- name: I'm unsure where to go
|
||||||
|
url: https://discord.gg/D8JsnBEuKb
|
||||||
|
about: If you are unsure where to go, then joining our Discord is recommended; Just ask!
|
||||||
|
|
32
.github/ISSUE_TEMPLATE/feature_request.yaml
vendored
32
.github/ISSUE_TEMPLATE/feature_request.yaml
vendored
|
@ -1,32 +0,0 @@
|
||||||
name: Feature Request
|
|
||||||
description: Request a feature that you would like for the app
|
|
||||||
title: "[Feature]: "
|
|
||||||
labels: ["feature", "need triage"]
|
|
||||||
assignees:
|
|
||||||
- ""
|
|
||||||
|
|
||||||
body:
|
|
||||||
- type: markdown
|
|
||||||
attributes:
|
|
||||||
value: |
|
|
||||||
Thanks for taking the time to fill out this feature request!
|
|
||||||
|
|
||||||
- type: textarea
|
|
||||||
id: feature-detail
|
|
||||||
attributes:
|
|
||||||
label: Feature detail
|
|
||||||
placeholder: Describe the feature you would like to see for the app
|
|
||||||
validations:
|
|
||||||
required: true
|
|
||||||
|
|
||||||
- type: dropdown
|
|
||||||
id: platform
|
|
||||||
attributes:
|
|
||||||
label: Platform
|
|
||||||
description: Choose the platform for the feature
|
|
||||||
options:
|
|
||||||
- Web
|
|
||||||
- Mobile App
|
|
||||||
- Server
|
|
||||||
validations:
|
|
||||||
required: true
|
|
Loading…
Reference in a new issue