Repository navigation
Initial contributors guide lines around features - #48928
Merged
Merged
Conversation
Signed-off-by: stianst <stianst@gmail.com>
stianst
force-pushed
the
features-guide-lines
branch
from
May 12, 2026 10:56
680b988 to
71230b0
Compare
vmuzikar
self-requested a review
May 12, 2026 11:56
ahus1
requested changes
May 12, 2026
Member
There was a problem hiding this comment.
Small changes, looks great to me. Proceed with merging once addressed.
vmuzikar
reviewed
May 13, 2026
Uh oh!
There was an error while loading. < 10000 a class="Link--inTextBlock" data-turbo="false" href="" aria-label="Please reload this page">Please reload this page.
mposolda
reviewed
May 13, 2026
| * Does not have to be feature complete | ||
| * Good test coverage is required | ||
| * Documentation is required, and should be updated as the feature evolves | ||
| * Does not have to provide backwards compatibility for APIs, nor migrating support |
Contributor
There was a problem hiding this comment.
Suggested change
| * Does not have to provide backwards compatibility for APIs, nor migrating support | |
| * Does not have to provide backwards compatibility for APIs, nor migrating support. Experimental features should be **never** enabled in the production environment as they can break later migration of the production instance. |
Is it possible to add some more "strong" warning about never enable experimental features in production? Would be good to avoid the bugs similar to this (saw some reports like this in the past):
- User enables experimental feature in his production instance in version X
- User creates new realm. That will for example add some new experimental authenticator to the "browser" flow
- Experimental feature is removed in version X+1. User migrates to this version. Now he tries to authenticate to his realm, but will be unable to do that due the issue like "Authenticator not available" as experimental authenticator impl does not exists anymore
Contributor
Author
There was a problem hiding this comment.
Updated to Is not supported
ryanemerson
reviewed
May 14, 2026
ryanemerson
reviewed
May 14, 2026
stianst
force-pushed
the
features-guide-lines
branch
from
May 21, 2026 07:46
440b930 to
0d998dc
Compare
Co-authored-by: Alexander Schwartz <alexander.schwartz@gmx.net> Signed-off-by: Stian Thorgersen <stianst@gmail.com>
stianst
force-pushed
the
features-guide-lines
branch
from
May 21, 2026 07:53
0d998dc to
7d68caa
Compare
ryanemerson
previously approved these changes
May 21, 2026
vmuzikar
reviewed
May 21, 2026
| * A review of test coverage is required prior to graduating a feature to preview | ||
| * A security review is required prior to graduating a feature to preview | ||
| * Review of any feedback or open issues must be resolved prior to graduating a feature to preview | ||
| * Should aim to provide backwards compatible APIs, and migration. However, this can be omitted if needed |
Contributor
There was a problem hiding this comment.
Suggested change
| * Should aim to provide backwards compatible APIs, and migration. However, this can be omitted if needed | |
| * Should aim to provide backwards compatible APIs, and migration. However, this can be omitted if needed, i.e. a breaking change can be introduced to a preview feature |
Contributor
Author
There was a problem hiding this comment.
You are basically just writing again what is in the first sentence
Contributor
There was a problem hiding this comment.
Do you mean:
but does not guarantee seamless upgrades
That does not read to me the same as "breaking changes can happen".
Contributor
Author
There was a problem hiding this comment.
I meant Should aim to provide backwards compatible APIs
sschu
reviewed
May 21, 2026
Co-authored-by: Sebastian Schuster <sebastian.schuster@bosch.com> Signed-off-by: Stian Thorgersen <stianst@gmail.com>
ryanemerson
approved these changes
May 27, 2026
ahus1
approved these changes
May 27, 2026
Contributor
Author
|
Merging this since it's been open for quite some time, if there is any more feedback let me know, or just send a PR to the file. |
Closed
sashyo
pushed a commit
to tide-foundation/keycloak-IGA
that referenced
this pull request
Jul 20, 2026
* Initial contributors guide lines around features Signed-off-by: stianst <stianst@gmail.com> * Apply suggestions from code review Co-authored-by: Alexander Schwartz <alexander.schwartz@gmx.net> Signed-off-by: Stian Thorgersen <stianst@gmail.com> * Update docs/features.md Co-authored-by: Sebastian Schuster <sebastian.schuster@bosch.com> Signed-off-by: Stian Thorgersen <stianst@gmail.com> --------- Signed-off-by: stianst <stianst@gmail.com> Signed-off-by: Stian Thorgersen <stianst@gmail.com> Co-authored-by: Alexander Schwartz <alexander.schwartz@gmx.net> Co-authored-by: Sebastian Schuster <sebastian.schuster@bosch.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Signed-off-by: stianst stianst@gmail.com