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.

Sign up for GitHub

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

Jump to bottom

add README.md in hack/ #87065

Merged
merged 1 commit into from Jan 17, 2020
Merged

add README.md in hack/ #87065

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
24 changes: 24 additions & 0 deletions hack/README.md
View file
Open in desktop
@@ -0,0 +1,24 @@
# Kubernetes hack GuideLines

This document describes how you can use the scripts from [`hack`](.) directory
and gives a brief introduction and explanation of these scripts.

## Overview

The [`hack`](.) directory contains many scripts that ensure continuous development of kubernetes,
enhance the robustness of the code, improve development efficiency, etc.
The explanations and descriptions of these scripts are helpful for contributors.
For details, refer to the following guidelines.

## Key scripts
Copy link
Contributor

Choose a reason for hiding this comment

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

This seems to just list every file, can you pick "key" scripts?

How about if we just tell people to run verify-all.sh before submitting a PR and if anything fails run update-all.sh?

Anyone interested in more detail should probably just look at the scripts themselves.

Listing every script this way is going to be out of date almost as soon as its submitted, and manually making a list of every file doesn't do anything particularly different from what github already does.

Copy link
Contributor

Choose a reason for hiding this comment

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

I think it's a good idea to pick up only key scripts and add guidance for each category(verify, update and etc.) in readme.md.
Are verify-all.sh and update-all.sh the only key scripts?

Copy link
Contributor

Choose a reason for hiding this comment

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

Yes, as they run all the verify and update scripts respectively.

Copy link
Contributor

Choose a reason for hiding this comment

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

I still think this could separate out update-all and verify-all into their own primary section

Copy link
Member Author

Choose a reason for hiding this comment

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

sure i will update it


* [`verify-all.sh`](verify-all.sh): This script is a vestigial redirection, Please do not add "real" logic. It is equivalent to `make verify`.
* [`update-all.sh`](update-all.sh): This script is a vestigial redirection, Please do not add "real" logic.
The `true` target of this makerule is `hack/make-rules/update.sh`.It is equivalent to `make update`.

## Attention
Note that all scripts must be run from the Kubernetes root directory.
**We should run `hack/verify-all.sh` before submitting a PR and if anything fails run `hack/update-all.sh`**.