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

introduce HIP 1: "Writing a HIP" #140

Merged
merged 18 commits into from
Sep 4, 2020

Conversation

bacongobbler
Copy link
Member

@bacongobbler bacongobbler commented Aug 13, 2020

As the Helm project receives more and more proposals, we should try to set a reasonable standard which proposal authors should adhere to ensure that proposals to the Helm project are well-written, thought out, and explained in a clear, concise manner.

This proposal format is inspired heavily by the Python Enhancement Proposal (PEP) process, with some minor modifications called out in proposal 1 (Writing a Proposal). I did not provide this process a fun name (KEPs, PEPs, DEPs), but suggestions are welcome, as it would make it simpler to reference these proposals in conversation!

@bacongobbler bacongobbler changed the title introduce "Writing a Proposal" introduce proposal 0001: "Writing a Proposal" Aug 13, 2020
@bridgetkromhout
Copy link
Member

I did not provide this process a fun name (KEPs, PEPs, DEPs), but suggestions are welcome, as it would make it simpler to reference these proposals in conversation!

HEP, like a hepcat (https://en.wikipedia.org/wiki/Hipster_(1940s_subculture))? HIP, Helm Improvement Proposal?

@bacongobbler
Copy link
Member Author

As discussed in today's call, I'll bring this to the helm-cartographers mailing list so other project maintainers can weigh in and see if this process would be helpful for them as well.

@bacongobbler
Copy link
Member Author

side note: I like HIP simply for the fact that it relates to a familiar english word, whereas HEP is common slang for a well-known subset of viruses (hepatitis C is commonly shortened down to "HEP C").

Copy link

@thomastaylor312 thomastaylor312 left a comment

Choose a reason for hiding this comment

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

Great work on this. Just some general feedback and edits

proposals/proposal-0001.md Outdated Show resolved Hide resolved
proposals/proposal-0001.md Outdated Show resolved Hide resolved
proposals/proposal-0001.md Outdated Show resolved Hide resolved
proposals/proposal-0001.md Outdated Show resolved Hide resolved
proposals/proposal-0001.md Outdated Show resolved Hide resolved
proposals/proposal-0001.md Outdated Show resolved Hide resolved
proposals/proposal-0001.md Outdated Show resolved Hide resolved
proposals/proposal-0001.md Outdated Show resolved Hide resolved
proposals/proposal-0001.md Outdated Show resolved Hide resolved
proposals/proposal-0001.md Outdated Show resolved Hide resolved
Signed-off-by: Matthew Fisher <matt.fisher@microsoft.com>
proposals/proposal-0001.md Outdated Show resolved Hide resolved
proposals/proposal-0001.md Outdated Show resolved Hide resolved
proposals/proposal-0001.md Outdated Show resolved Hide resolved
proposals/proposal-0001.md Outdated Show resolved Hide resolved
proposals/proposal-0001.md Outdated Show resolved Hide resolved
proposals/proposal-0001.md Outdated Show resolved Hide resolved
proposals/proposal-0001.md Outdated Show resolved Hide resolved
proposals/proposal-0001.md Outdated Show resolved Hide resolved
Matthew Fisher added 4 commits August 21, 2020 07:39
Signed-off-by: Matthew Fisher <matt.fisher@microsoft.com>
Signed-off-by: Matthew Fisher <matt.fisher@microsoft.com>
Signed-off-by: Matthew Fisher <matt.fisher@microsoft.com>
Signed-off-by: Matthew Fisher <matt.fisher@microsoft.com>
Matthew Fisher added 4 commits August 21, 2020 09:14
Signed-off-by: Matthew Fisher <matt.fisher@microsoft.com>
Signed-off-by: Matthew Fisher <matt.fisher@microsoft.com>
Signed-off-by: Matthew Fisher <matt.fisher@microsoft.com>
Signed-off-by: Matthew Fisher <matt.fisher@microsoft.com>
@bacongobbler bacongobbler changed the title introduce proposal 0001: "Writing a Proposal" introduce HIP 0001: "Writing a HIP" Aug 21, 2020
Matthew Fisher added 5 commits August 21, 2020 09:51
Signed-off-by: Matthew Fisher <matt.fisher@microsoft.com>
Signed-off-by: Matthew Fisher <matt.fisher@microsoft.com>
Signed-off-by: Matthew Fisher <matt.fisher@microsoft.com>
Signed-off-by: Matthew Fisher <matt.fisher@microsoft.com>
Signed-off-by: Matthew Fisher <matt.fisher@microsoft.com>
@bacongobbler
Copy link
Member Author

Okay, I think I've addressed all outstanding comments. I also included HIP 2 which provides a sample HIP template for others to use when writing their own HIPs. Ready for another round of reviews!

@bacongobbler bacongobbler changed the title introduce HIP 0001: "Writing a HIP" introduce HIP 1: "Writing a HIP" Aug 21, 2020
Signed-off-by: Matthew Fisher <matt.fisher@microsoft.com>
hips/hip-0002.md Outdated Show resolved Hide resolved
Matthew Fisher added 2 commits August 21, 2020 16:06
Signed-off-by: Matthew Fisher <matt.fisher@microsoft.com>
Signed-off-by: Matthew Fisher <matt.fisher@microsoft.com>
Copy link
Contributor

@hickeyma hickeyma 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 @bacongobbler

Copy link

@jorgecarleitao jorgecarleitao left a comment

Choose a reason for hiding this comment

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

(I am just a user of Helm)

I went through this and I like it very much. I left minor comments.

hips/hip-0001.md Outdated Show resolved Hide resolved
hips/hip-0001.md Show resolved Hide resolved
hips/hip-0001.md Show resolved Hide resolved
Signed-off-by: Matthew Fisher <matt.fisher@microsoft.com>
Copy link
Contributor

@mattfarina mattfarina left a comment

Choose a reason for hiding this comment

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

lgtm

@bacongobbler bacongobbler merged commit ccfe6d8 into helm:master Sep 4, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

8 participants