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

Add proposal process #66

Merged
merged 3 commits into from
Feb 22, 2024
Merged

Add proposal process #66

merged 3 commits into from
Feb 22, 2024

Conversation

nikimanoledaki
Copy link
Contributor

@nikimanoledaki nikimanoledaki commented Feb 21, 2024

What type of PR is this?

kind/documentation

What this PR does / why we need it:

  • Creates a proposal process through this repo
  • Changes to proposals / design docs can be tracked through git
  • Adds template with instructions (inspired by KEP/ADRs)
  • Helps to deprecate the design doc (which doesn't scale well)

Which issue(s) this PR fixes:

#47

Special notes for your reviewer (optional):

Please let me know what you think about creating a proposal process through this repository. It's similar to the KEP process in Kubernetes or ADRs which is widely used in OSS. Going through git would allow a better tracking of the history of proposals and how they change. It would also help to have discussions on individual points via PRs.

@nikimanoledaki nikimanoledaki added the kind/documentation Improvements or additions to documentation label Feb 21, 2024
@nikimanoledaki nikimanoledaki changed the title Add proposal template Add proposal process Feb 21, 2024
Copy link
Contributor

@rossf7 rossf7 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@nikimanoledaki I like this approach a lot and I think it can help a lot with larger features / deliverables the WG will work on.

I have more experience with ADRs than the KEP process. Looks like this is a lighter version of the KEP process?

It would be good to hear opinions from others who are more familiar with KEPs.

CONTRIBUTING.md Outdated Show resolved Hide resolved
docs/proposals/proposal-000-template.md Outdated Show resolved Hide resolved
Co-authored-by: Ross Fairbanks <[email protected]>
Signed-off-by: nikimanoledaki <[email protected]>
Co-authored-by: Ross Fairbanks <[email protected]>
Signed-off-by: nikimanoledaki <[email protected]>
@dipankardas011
Copy link
Contributor

Hi

Copy link
Member

@leonardpahlke leonardpahlke left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, thanks!

@leonardpahlke
Copy link
Member

Having some kind of design document with the usual questions is a good change. The KEP template is quite extensive. We will see which sections will make sense once we use it a few times. Lets try this out and make adjustments if needed.

@leonardpahlke leonardpahlke merged commit 077407a into main Feb 22, 2024
1 check passed
@nikimanoledaki nikimanoledaki deleted the nm/add-kep branch February 22, 2024 10:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
kind/documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants