...

Text file src/k8s.io/kubernetes/hack/README.md

Documentation: k8s.io/kubernetes/hack

     1# Kubernetes hack GuideLines
     2
     3This document describes how you can use the scripts from [`hack`](.) directory 
     4and gives a brief introduction and explanation of these scripts. 
     5
     6## Overview
     7
     8The [`hack`](.) directory contains many scripts that ensure continuous development of kubernetes, 
     9enhance the robustness of the code, improve development efficiency, etc. 
    10The explanations and descriptions of these scripts are helpful for contributors. 
    11For 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. 
    17The `true` target of this makerule is `hack/make-rules/update.sh`.It is equivalent to `make update`.
    18
    19## Attention
    20Note 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

View as plain text