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 a list of HIPs to the README #206

Merged
merged 1 commit into from
May 4, 2022
Merged

Conversation

marckhouzam
Copy link
Member

HIP file names indicate the HIP number. Remembering which HIP number
represents which proposal is difficult. Having the title of the HIP
listed in the README should make finding the correct HIP easier.

The disadvantage is of course that this list must be maintained.

HIP file names indicate the HIP number.  Remembering which HIP number
represents which proposal is difficult.  Having the title of the HIP
listed in the README should make finding the correct HIP easier.

Signed-off-by: Marc Khouzam <[email protected]>
@marckhouzam
Copy link
Member Author

Copy link
Member

@technosophos technosophos left a comment

Choose a reason for hiding this comment

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

This would be great. I usually hunt-and-click until I find the right HIP

@marckhouzam
Copy link
Member Author

I used this again today to find which hip was the distributed process hip 😄

Any other approval to get this merged?

@marckhouzam
Copy link
Member Author

Another approach which would be more future-proof would be to simply rename the file of each HIP in git. Maybe that would be better?

For example:
hip-0001.md would become something like hip-0001-Writing_a_HIP.md.

Opinions?

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.

I think a good first step is having the list in the README. We can change this in the future, if we want.

@mattfarina mattfarina merged commit 974e493 into helm:main May 4, 2022
@marckhouzam marckhouzam deleted the feat/toc branch May 4, 2022 20:38
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.

4 participants