From 2571ae9096ff16b5b994f435406cffccfb96e43f Mon Sep 17 00:00:00 2001 From: Maksim Nabokikh Date: Mon, 25 Apr 2022 10:33:02 +0400 Subject: [PATCH] Apply suggestions from code review MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Mark Sagi-Kazar Co-authored-by: Márk Sági-Kazár Signed-off-by: m.nabokikh --- .github/ISSUE_TEMPLATE/config.yml | 4 ++++ enhancements/README.md | 12 ++++++------ enhancements/_title-YYYY-MM-DD-#issue.md | 4 ++-- 3 files changed, 12 insertions(+), 8 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml index 4e78de20..64156bfa 100644 --- a/.github/ISSUE_TEMPLATE/config.yml +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -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 diff --git a/enhancements/README.md b/enhancements/README.md index 948897d9..f9454581 100644 --- a/enhancements/README.md +++ b/enhancements/README.md @@ -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 diff --git a/enhancements/_title-YYYY-MM-DD-#issue.md b/enhancements/_title-YYYY-MM-DD-#issue.md index 88b94513..da671098 100644 --- a/enhancements/_title-YYYY-MM-DD-#issue.md +++ b/enhancements/_title-YYYY-MM-DD-#issue.md @@ -1,4 +1,4 @@ -# Enhancement Proposal (EP) - - +# 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