k-space/dex
Archived
11
0
Fork 0
Code Issues Pull Requests Packages Projects Activity

fix: Move enhancements to the docs folder

Browse Source 
Signed-off-by: m.nabokikh <maksim.nabokikh@flant.com>
This commit is contained in:
m.nabokikh
2022-05-20 16:19:20 +04:00
parent 2571ae9096
commit a98ab893c2
2 changed files with 2 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

23
docs/enhancements/README.md Normal file
View File

@@ -0,0 +1,23 @@
# Dex Enhancement Proposal
## Why do we need it?
Dex Enhancement Proposal (DEP) is a design document providing information to the community, or describing a new feature for Dex.
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), [discussions](https://github.com/dexidp/dex/discussions) and [DEPs](https://github.com/dexidp/dex/tree/master/docs/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
1. Fork the repo.
2. Copy the [`docs/enhancements/_title-YYYY-MM-DD-#issue.md`](docs/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.