mirror of
https://github.com/optim-enterprises-bv/Mailu-OIDC.git
synced 2025-10-29 09:12:41 +00:00
32422d3f49
- 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
64 lines
2.3 KiB
Markdown
64 lines
2.3 KiB
Markdown
## Enhancement
|
|
|
|
This pull request enhances the following feature(s):
|
|
<!--
|
|
Add the features this PR enhances here. If they are related to an issue, reference it, prepend with 'closes' to auto-close them on merge.
|
|
|
|
Examples:
|
|
- Add possibility to change the color of the button
|
|
- Improve setup documentation
|
|
|
|
If this PR enhances multiple features, make sure they are closely related. If not, consider creating multiple PRs.
|
|
-->
|
|
- Your enhancement here. closes #000
|
|
|
|
## Details of Implementation
|
|
|
|
### What's new
|
|
|
|
<!--
|
|
Describe the feature(s) after the enhancement.
|
|
|
|
Examples:
|
|
- The button can now be red, blue, or green
|
|
- The setup documentation now better explains the properties available
|
|
- The property `NEW_PROPERTY` is now used to configure the button label
|
|
-->
|
|
|
|
### Breaking changes
|
|
|
|
<!--
|
|
Describe any breaking changes introduced by this enhancement. If there are none, you can remove this section.
|
|
|
|
Examples:
|
|
- The button is now red by default
|
|
- The property `OIDC_ENABLED` is now **required**
|
|
- The property `SOME_PROPERTY` is renamed to `NEW_PROPERTY`
|
|
|
|
It can be helpful to provide a migration path for users to follow, which can be added to the documentation later.
|
|
-->
|
|
|
|
### Previous behavior
|
|
|
|
<!--
|
|
Describe the feature(s) before the enhancement.
|
|
|
|
Examples:
|
|
- The button was always blue
|
|
- The setup documentation was missing some steps
|
|
- The property `OIDC_ENABLED` was optional
|
|
- The property `SOME_PROPERTY` was used to configure the button label
|
|
-->
|
|
|
|
## Checklist
|
|
|
|
Before we can consider review and merge, please make sure the following list is done and checked.
|
|
|
|
- [ ] Make sure you follow our [Code of Conduct](https://github.com/heviat/Mailu-OIDC/blob/master/CODE_OF_CONDUCT.md).
|
|
- [ ] This enhancement is tested and works as expected.
|
|
- [ ] This enhancement modifies existing functionality[^1].
|
|
- [ ] This enhancement does not break any existing functionality, or breaks it intentionally (documented above).
|
|
- [ ] Add a [Changelog](https://mailu.io/master/contributors/workflow.html#changelog) entry file.
|
|
|
|
[^1]: If this pull request introduces new functionality, please create a new-feature pull request instead. If it only fixes a bug but does not otherwise modify behaviour, please create a bug-fix pull request instead.
|