Files
Mailu-OIDC/.github/ISSUE_TEMPLATE/enhancement-request.yml
Luca Bosin 32422d3f49 Improve GitHub user experience
- Improve formatting of `AUTHORS.md`, `CONTRIBUTING.md`, `LICENSE.md`, `README.md` and `SECURITY.md`
- Update wording to include `Mailu-OIDC`-related information in `AUTHORS.md`, `CONTRIBUTING.md`, `LICENSE.md`, `README.md`, `RELEASE_TEMPLATE.md`, `SECURITY.md`
- Add OIDC setup guide to `README.md`
- Switch from issue template to issue forms
- Add pull-request templates
2024-07-23 17:13:40 +02:00

76 lines
3.3 KiB
YAML

name: Enhancement Request
description: File an enhancement request to suggest improvements to existing functionality.
title: "Allow changing the OIDC login button color / Improve the setup documentation / ..."
labels: ["enhancement"]
assignees: ["encotric", "wombosvideo"]
body:
- type: markdown
attributes:
value: |
## Enhancement Request
Thank you for opening an issue with Mailu-OIDC. Please understand that enhancement requests are meant for enhancements to existing functionality only. The enhancement request should provide clear details of the enhancement and the reason for the enhancement.
Before you open your issue
- Check if no issue or pull-request for this already exists.
- Check the [Mailu-OIDC](https://github.com/heviat/Mailu-OIDC) or [Mailu](https://mailu.io/master/) documentation and [FAQ](https://mailu.io/master/faq.html). (Tip, use the search function on the Mailu documentation page)
- You understand `Mailu-OIDC` is maintained by volunteers in their **free time** — be concise, civil and accept that delays can occur.
- The title of the issue should be short and simple. It should contain specific terms related to the actual enhancement. Be specific while writing the title.
## Environment & Version
- type: dropdown
id: version
attributes:
label: Version
description: "Use `docker ps -a | grep mailu | awk '{print $2}' | cut -d: -f2` to get the version you are running or `grep MAILU_VERSION docker-compose.yml mailu.env` from the config file."
options:
- '2024.06'
- 'master'
- Not sure
- Not listed
validations:
required: true
- type: markdown
attributes:
value: |
Keep in mind that enhancements will be considered for the latest version of Mailu-OIDC. If you are not using the latest version, please upgrade before filing an enhancement request.
## Enhancement Description
- type: textarea
id: problem
attributes:
label: Related Problem
description: If your enhancement request is related to a problem, please provide a clear and concise description of what the problem is.
- type: textarea
id: improvement
attributes:
label: Improvement Description
description: Explain the enhancement in a few sentences. What should be changed or added?
validations:
required: true
- type: textarea
id: alternatives
attributes:
label: Alternatives
description: If applicable, describe any alternative solutions or features you've considered.
- type: markdown
attributes:
value: |
## Additional Information
- type: textarea
id: implementation
attributes:
label: Implementation Details
description: If you have an idea of how the enhancement could be implemented, please provide details here.
- type: textarea
id: additional
attributes:
label: Additional Context
description: Add any other context about the enhancement request here.
- type: textarea
id: screenshots
attributes:
label: Screenshots
description: If applicable, add screenshots to help explain the enhancement request. This can be a screenshot of the current behavior or a mockup of the desired behavior.