Arsharth/dex
1
0
Fork 0
forked from mystiq/dex
Code Issues Pull requests Projects Releases Packages Wiki Activity

Apply suggestions from code review

Browse source 
Signed-off-by: Mark Sagi-Kazar <mark.sagikazar@gmail.com>

Co-authored-by: Márk Sági-Kazár <sagikazarmark@users.noreply.github.com>
Signed-off-by: m.nabokikh <maksim.nabokikh@flant.com>
This commit is contained in:
Maksim Nabokikh 2022-04-25 10:33:02 +04:00 committed by m.nabokikh
parent 38fe0f5319
commit 2571ae9096
3 changed files with 12 additions and 8 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
.github/ISSUE_TEMPLATE/config.yml vendored
View file

@ -11,3 +11,7 @@ contact_links:
- name: 💬 Slack channel
url: https://cloud-native.slack.com/messages/dexidp
about: Please ask and answer questions here
- name: 💡 Dex Enhancement Proposal
url: https://github.com/dexidp/dex/tree/master/enhancements/README.md
about: Open a proposal for significant architectural change

12
enhancements/README.md
View file

@ -1,17 +1,17 @@
# Enhancement Proposal
# Dex 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.
Dex Enhancement Proposal (DEP) 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.
We intend DEPs to be the primary mechanisms for proposing major new features or significant changes to existing ones.
This will make it easier for the community to describe, track, and look through the history of changes that affected the development of the project.
## 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).
1. Search GitHub for previous [issues](https://github.com/dexidp/dex/issues), [discussions](https://github.com/dexidp/dex/discussions) and [DEPs](https://github.com/dexidp/dex/tree/master/enhancements).
2. If a discussion does not exist, [open it](https://github.com/dexidp/dex/discussions/new?category=Ideas).
3. Ensure that writing enhancement proposal is necessary for you change by discussing it with a community.
### Writing an enhancement proposal

4
enhancements/_title-YYYY-MM-DD-#issue.md
View file

@ -1,4 +1,4 @@
# Enhancement Proposal (EP) <issue#> - <YYYY-MM-DD> - <title>
# Dex Enhancement Proposal (DEP) <issue#> - <YYYY-MM-DD> - <title>
## Table of Contents
@ -31,7 +31,7 @@
### Non-goals
- List work that is entirely out of the scope of this enhancement. Use this to define EP borders to keep work focused.
- List work that is entirely out of the scope of this enhancement. Use this to define DEP borders to keep work focused.
- All planned future enhancements should be listed in one of the following blocks - Future Improvements.
## Proposal