-
Notifications
You must be signed in to change notification settings - Fork 834
docs: adding graduation path doc #4207
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: master
Are you sure you want to change the base?
Changes from all commits
fd5320b
82478a1
a240640
d1332de
3c5722a
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -114,6 +114,20 @@ If you want to contribute to Helm chart, Gatekeeper auto-generates versioned Hel | |
|
|
||
| If you want to contribute code, check out the [Developers](developers.md) guide to get started. | ||
|
|
||
| ### API and Feature Maturity Stages | ||
|
|
||
| When contributing new features or APIs, please be aware of Gatekeeper's maturity stage requirements: | ||
|
|
||
| - **Alpha** features must be behind feature flags and clearly documented as experimental | ||
| - **Beta** features should be well-tested, enabled by default, and production-ready | ||
| - **GA** features require comprehensive testing, backward compatibility guarantees, and performance SLOs | ||
|
|
||
| See the [Feature/API Stage Requirements](https://github.com/open-policy-agent/gatekeeper/blob/master/docs/Backwards_Compatibility.md#featureapi-stage-requirements) | ||
|
||
| section in our Backwards Compatibility document for detailed requirements at each stage. | ||
|
|
||
| When modifying existing APIs or features, please consult the [Backwards Compatibility](https://github.com/open-policy-agent/gatekeeper/blob/master/docs/Backwards_Compatibility.md) | ||
| guide to ensure changes meet our stability guarantees. | ||
|
|
||
| ## Contributing Templates | ||
|
|
||
| If you'd like to contribute a Constraint Template to the [Gatekeeper Policy Library](https://open-policy-agent.github.io/gatekeeper-library/website/), you can find documentation on how to do that [here in the library's README](https://github.com/open-policy-agent/gatekeeper-library?tab=readme-ov-file#how-to-contribute-to-the-library). | ||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The '>' symbol may render incorrectly in some Markdown parsers. Consider using '>' HTML entity or writing it as 'greater than 80%' to ensure consistent rendering across different platforms.