Skip to content

Commit 9519d97

Browse files
authored
Merge pull request kubernetes#87065 from tanjunchen/add-README-hack
add README.md in hack/
2 parents 2ea483b + 0c77101 commit 9519d97

File tree

1 file changed

+24
-0
lines changed

1 file changed

+24
-0
lines changed

hack/README.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
# Kubernetes hack GuideLines
2+
3+
This document describes how you can use the scripts from [`hack`](.) directory
4+
and gives a brief introduction and explanation of these scripts.
5+
6+
## Overview
7+
8+
The [`hack`](.) directory contains many scripts that ensure continuous development of kubernetes,
9+
enhance the robustness of the code, improve development efficiency, etc.
10+
The explanations and descriptions of these scripts are helpful for contributors.
11+
For details, refer to the following guidelines.
12+
13+
## Key scripts
14+
15+
* [`verify-all.sh`](verify-all.sh): This script is a vestigial redirection, Please do not add "real" logic. It is equivalent to `make verify`.
16+
* [`update-all.sh`](update-all.sh): This script is a vestigial redirection, Please do not add "real" logic.
17+
The `true` target of this makerule is `hack/make-rules/update.sh`.It is equivalent to `make update`.
18+
19+
## Attention
20+
Note that all scripts must be run from the Kubernetes root directory.
21+
**We should run `hack/verify-all.sh` before submitting a PR and if anything fails run `hack/update-all.sh`**.
22+
23+
24+

0 commit comments

Comments
 (0)