Skip to content
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

✨📖 Adding designs folder and sample template #809

Merged

Conversation

christopherhein
Copy link
Member

Per the discussion in the controller-runtime this fixes #807 adding so that I can add the design document for #518

Signed-off-by: Chris Hein me@chrishein.com

@k8s-ci-robot k8s-ci-robot added the cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. label Feb 20, 2020
@christopherhein
Copy link
Member Author

/assign @vincepri

@k8s-ci-robot k8s-ci-robot added the size/S Denotes a PR that changes 10-29 lines, ignoring generated files. label Feb 20, 2020
@christopherhein christopherhein changed the title ✨📖Adding designs folder and sample template ✨📖 Adding designs folder and sample template Feb 20, 2020
@k8s-ci-robot k8s-ci-robot added size/L Denotes a PR that changes 100-499 lines, ignoring generated files. and removed size/S Denotes a PR that changes 10-29 lines, ignoring generated files. labels Feb 20, 2020
@vincepri vincepri added this to the v0.5.x milestone Feb 21, 2020
@christopherhein
Copy link
Member Author

/assign @DirectXMan12

@DirectXMan12
Copy link
Contributor

Let's not do the full KEP template. I'd like to see something closer to the KB template (in fact, I kinda just think we should copy it). IMO, at least for us, KEPs are too complicated, intimidating, and paperwork-heavy.

@DirectXMan12
Copy link
Contributor

Might be worth having a "is this a breaking change" section for controller-runtime too.

What I'm looking for when I read a proposal is:

  • What does it do?
  • Is it breaking (and did we consider making it non-breaking), and how does it evolve in the future (additional options, dependency changes, etc, if relevant)?
  • How do we teach this (see Rust RFCs) and how does an example look?

That's pretty much it in terms of structure. At least in my opinion, anything more than that just gets in the way of people actually doing things at this scale.

Key point from the KB design template:

we want enough information to evaluate the design, but not so much that you're
annoyed by the overall design process and decide to bake cookies instead.

We should copy the designs README from KB too (adjusting slightly as necessary).

@k8s-ci-robot k8s-ci-robot added size/M Denotes a PR that changes 30-99 lines, ignoring generated files. and removed size/L Denotes a PR that changes 100-499 lines, ignoring generated files. labels Feb 24, 2020
Signed-off-by: Chris Hein <me@chrishein.com>
@vincepri
Copy link
Member

/lgtm

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Feb 24, 2020
@DirectXMan12
Copy link
Contributor

/approve

@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: christopherhein, DirectXMan12

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 /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@k8s-ci-robot k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Feb 25, 2020
@k8s-ci-robot k8s-ci-robot merged commit 8507812 into kubernetes-sigs:master Feb 25, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. lgtm "Looks good to me", indicates that a PR is ready to be merged. size/M Denotes a PR that changes 30-99 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Proposals folder and template
4 participants