github/kubernetes
1
0
Fork 0
mirror of https://github.com/k3s-io/kubernetes.git synced 2025-07-29 14:37:00 +00:00
Code Issues Projects Releases Wiki Activity

Merge pull request #87065 from tanjunchen/add-README-hack

Browse Source 
add README.md in hack/
This commit is contained in:
Kubernetes Prow Robot 2020-01-16 18:56:55 -08:00 committed by GitHub
commit 9519d9764d
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 24 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
hack/README.md Normal file
View File

@ -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
* [`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`**.