feat: add enhancement template #2486
Conversation
|
Seems to be related to #2370 |
There was a problem hiding this comment.
This is great @nabokihms, thanks a lot for writing it!
I had a few suggestions and a few ideas that might be worth discussing, but overall I think this is a great start.
enhancements/README.md
Outdated
| @@ -0,0 +1,23 @@ | |||
| # Enhancement Proposal | |||
There was a problem hiding this comment.
We should add a link to this file in https://github.com/dexidp/dex/blob/master/.github/ISSUE_TEMPLATE/config.yml so users can find it when looking to open an issue.
There was a problem hiding this comment.
Also:
- Should we call these proposals DEPs (Dex Enhancement Proposals?)
- Should we setup a separate repository for them?
- Should we move the whole thing under
docs/or some other more generic directory? - How would EPs related to ADRs? Should we use both?
There was a problem hiding this comment.
Speaking about the issue template - no problem, I will add a link.
- I'm good with it. It is more identical, and we can differentiate proposals for different projects in the future.
- I think it would be best to start with this repo because now we do not have too many cases for writing proposals. If it becomes inconvenient, we will always be able to move proposals to a separate repo.
- This is a tricky question. As I see it, proposals are not connected to anything generic. That is why I moved them to the root. Although, it is discussable. If you think we should move them to docs, it is okay for me.
- I assume we will have EPs for all complicated architecture choices in the future, so it is not necessary to use both.
|
|
||
| ## Summary | ||
|
|
||
| - Provide a one-paragraph description of the expected change here. |
There was a problem hiding this comment.
Maybe these hints should be HTML comments (similar to the hints in the PR template) to make sure they don't show up in the rendered content in case someone doesn't delete them?
There was a problem hiding this comment.
This is a good question. I consciously left these comments in plain text to kind of force deleting them because I assume we do not want to see documents with comments in our repository.
nabokihms
force-pushed
the
enhancement-template
branch
from
dba5e38
to
51c55ff
Compare
Signed-off-by: m.nabokikh <maksim.nabokikh@flant.com>
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>
Signed-off-by: m.nabokikh <maksim.nabokikh@flant.com>
nabokihms
force-pushed
the
enhancement-template
branch
from
51c55ff
to
a98ab89
Compare
Signed-off-by: m.nabokikh maksim.nabokikh@flant.com
Overview
Add an enhancement proposal template and a README about how to propose significant features.
What this PR does / why we need it
This is an attempt of formalizing proposing of major features. As of today, we only have issues or discussions to propose feature of all sizes.
Special notes for your reviewer
Does this PR introduce a user-facing change?