-
Notifications
You must be signed in to change notification settings - Fork 898
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
Update 20220926-contrib-component-guidelines.md #2329
Conversation
I think this is a fair ask and definitely a good practice! If we like to enforce this during the current clean up effort, we should try to get this merged soon & communicate this to /contrib component owners cc @kimwnasptd |
@kimwnasptd |
After some discussion with @juliusvonkohout we decided to use this PR towards the overarching goal of better defining the implementation details (or technical requirements) that we would expect from the contrib components. We've had context around this in other places, like #2286 (comment) and kubeflow/kubeflow#6662. The first step will be to break down the requirements to 2 categories:
The first category is regarding what we currently have. Requirements regarding the file structure of the addons. Things like having a README, exposing upgrade instructions and examples. Then the next one will be a list of more technical requirements that we will expect these addons to follow |
Some aspects that I believe we'll need to re-evaluate are:
Also we could think about a model where we explicitly "rank"/document how much an addon aligns with the requirements. So that users looking at different addons can know the state and be able to decide which ones they want to add in their platform cc @annajung |
Adding some items we discussed with @juliusvonkohout and @kromanow94 live as functional requirements:
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: juliusvonkohout The full list of commands accepted by this bot can be found here. The pull request process is described here
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
i have added the necessary changes. |
/lgtm Thanks @juliusvonkohout! |
@kimwnasptd @annajung this was missing from #2286 (comment) and exspecially the kuberay integration shows that proper projects can easily implement it.