38fe0f5319
Signed-off-by: m.nabokikh <maksim.nabokikh@flant.com>
24 lines
1.1 KiB
Markdown
24 lines
1.1 KiB
Markdown
# Enhancement Proposal
|
|
|
|
## Why do we need it?
|
|
|
|
Enhancement Proposal (EP) is a design document providing information to the community, or describing a new feature for Dex.
|
|
|
|
We intend EPs to be the primary mechanisms for proposing major new features.
|
|
This will make it easier for community to describe, track, and look through the history of changes that a going to affect the future development of a product.
|
|
|
|
## Process
|
|
|
|
### Before starting
|
|
1. Search GitHub for [previous issues](https://github.com/dexidp/dex/issues) and [EPs](https://github.com/dexidp/dex/tree/master/enhancements).
|
|
2. If an issue does not exist, [open it](https://github.com/dexidp/dex/issues/new?assignees=&labels=&template=feature_request.yaml).
|
|
3. Ensure that writing enhancement proposal is necessary for you change by discussing it with a community.
|
|
|
|
### Writing an enhancement proposal
|
|
|
|
1. Fork the repo.
|
|
2. Copy the [`enhancements/_title-YYYY-MM-DD-#issue.md`](enhancements/_title-YYYY-MM-DD-#issue.md) template with the appropriate
|
|
name.
|
|
3. Fill all sections according to hints in them. Provide as much information as you can.
|
|
4. Submit your PR and discuss it with the Dex team.
|