From 41707a6b71100b038aef7a74bcc992f8ba4088b6 Mon Sep 17 00:00:00 2001 From: Matthew Fisher Date: Mon, 22 Feb 2021 09:54:27 -0800 Subject: [PATCH 1/5] docs(CONTRIBUTING): writing a HIP Signed-off-by: Matthew Fisher --- CONTRIBUTING.md | 18 +++++++++++++++++- 1 file changed, 17 insertions(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 308154af5..29809c357 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -200,9 +200,25 @@ below. and reduce noise. Should the issue need to stay open, the `keep open` label can be added. 4. Issue closure +## Writing a Feature + +Before writing a new feature for Helm, please make sure to write up a [Helm +Improvement Proposal](https://github.com/helm/community/tree/master/hips). A +Helm Improvement Proposal is a design document that describes a new feature for +the Helm project. The proposal should provide a concise technical specification +of the feature and a rationale for the feature. + +[HIP 1](https://github.com/helm/community/blob/master/hips/hip-0001.md) +describes the process to write a HIP as well as the review process. + +After your proposal has been approved, follow the [developer's +guide](https://helm.sh/docs/community/developers/) to get started. + ## How to Contribute a Patch -1. Identify or create the related issue. +1. Identify or create the related issue. If you're proposing a larger change to + Helm, consider writing a [Helm Improvement + Proposal](https://github.com/helm/community/tree/master/hips). 2. Fork the desired repo; develop and test your code changes. 3. Submit a pull request, making sure to sign your work and link the related issue. From 2c114125a88d46a908fe42a05b5707360c8ca57a Mon Sep 17 00:00:00 2001 From: Matthew Fisher Date: Mon, 22 Feb 2021 11:12:32 -0800 Subject: [PATCH 2/5] keep it concise Signed-off-by: Matthew Fisher --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 29809c357..26cd7688e 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -206,7 +206,7 @@ Before writing a new feature for Helm, please make sure to write up a [Helm Improvement Proposal](https://github.com/helm/community/tree/master/hips). A Helm Improvement Proposal is a design document that describes a new feature for the Helm project. The proposal should provide a concise technical specification -of the feature and a rationale for the feature. +and rationale for the feature. [HIP 1](https://github.com/helm/community/blob/master/hips/hip-0001.md) describes the process to write a HIP as well as the review process. From 6cea2847bedbac299351b87bbf6f2b375fc24787 Mon Sep 17 00:00:00 2001 From: Matthew Fisher Date: Tue, 23 Feb 2021 08:43:55 -0800 Subject: [PATCH 3/5] more words Signed-off-by: Matthew Fisher --- CONTRIBUTING.md | 26 +++++++++++++++++--------- 1 file changed, 17 insertions(+), 9 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 26cd7688e..8ea1e7392 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -191,7 +191,9 @@ below. issue to a milestone until the questions are answered. - We attempt to do this process at least once per work day. 3. Discussion - - issues that are labeled as `feature` or `bug` should be connected to the PR that resolves it. + - Issues that are labeled `feature` or `proposal` must write a Helm Improvement Proposal (HIP). + See [Proposing an Idea](#proposing-an-idea). Smaller quality-of-life enhancements are exempt. + - Issues that are labeled as `feature` or `bug` should be connected to the PR that resolves it. - Whoever is working on a `feature` or `bug` issue (whether a maintainer or someone from the community), should either assign the issue to themself or make a comment in the issue saying that they are taking it. @@ -200,16 +202,22 @@ below. and reduce noise. Should the issue need to stay open, the `keep open` label can be added. 4. Issue closure -## Writing a Feature +## Proposing an Idea -Before writing a new feature for Helm, please make sure to write up a [Helm -Improvement Proposal](https://github.com/helm/community/tree/master/hips). A -Helm Improvement Proposal is a design document that describes a new feature for -the Helm project. The proposal should provide a concise technical specification -and rationale for the feature. +Before proposing a new idea to the Helm project, please make sure to write up a [Helm Improvement +Proposal](https://github.com/helm/community/tree/master/hips). A Helm Improvement Proposal is a +design document that describes a new feature for the Helm project. The proposal should provide a +concise technical specification and rationale for the feature. -[HIP 1](https://github.com/helm/community/blob/master/hips/hip-0001.md) -describes the process to write a HIP as well as the review process. +It is also worth considering vetting your idea with the community via the +[cncf-helm](mailto:cncf-helm@lists.cncf.io) mailing list. Vetting an idea publicly before going as +far as writing a proposal is meant to save the potential author time. Many ideas have been proposed +- it's quite likely there are others in the community who may be working on a similar proposal, or a + similar proposal may have already been written. + +HIPs are submitted to the [helm/community repository](https://github.com/helm/community). [HIP +1](https://github.com/helm/community/blob/master/hips/hip-0001.md) describes the process to write a +HIP as well as the review process. After your proposal has been approved, follow the [developer's guide](https://helm.sh/docs/community/developers/) to get started. From b704e84dd1136da9fad38e712bd3c580c8d969d8 Mon Sep 17 00:00:00 2001 From: Matthew Fisher Date: Tue, 23 Feb 2021 08:45:14 -0800 Subject: [PATCH 4/5] formatting Signed-off-by: Matthew Fisher --- CONTRIBUTING.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 8ea1e7392..b7cac52b7 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -211,9 +211,9 @@ concise technical specification and rationale for the feature. It is also worth considering vetting your idea with the community via the [cncf-helm](mailto:cncf-helm@lists.cncf.io) mailing list. Vetting an idea publicly before going as -far as writing a proposal is meant to save the potential author time. Many ideas have been proposed -- it's quite likely there are others in the community who may be working on a similar proposal, or a - similar proposal may have already been written. +far as writing a proposal is meant to save the potential author time. Many ideas have been proposed; +it's quite likely there are others in the community who may be working on a similar proposal, or a +similar proposal may have already been written. HIPs are submitted to the [helm/community repository](https://github.com/helm/community). [HIP 1](https://github.com/helm/community/blob/master/hips/hip-0001.md) describes the process to write a From abadc5468487f7dcd47035afe8591634ad2ffde4 Mon Sep 17 00:00:00 2001 From: Matthew Fisher Date: Tue, 23 Feb 2021 08:45:52 -0800 Subject: [PATCH 5/5] use relative linking Signed-off-by: Matthew Fisher --- CONTRIBUTING.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index b7cac52b7..a67d95c9e 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -225,8 +225,7 @@ guide](https://helm.sh/docs/community/developers/) to get started. ## How to Contribute a Patch 1. Identify or create the related issue. If you're proposing a larger change to - Helm, consider writing a [Helm Improvement - Proposal](https://github.com/helm/community/tree/master/hips). + Helm, see [Proposing an Idea](#proposing-an-idea). 2. Fork the desired repo; develop and test your code changes. 3. Submit a pull request, making sure to sign your work and link the related issue.