[apisix-ingress-controller] branch master updated: docs: add pre-commit todo in the development guide (#907)

[li...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

lingsamuel pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/apisix-ingress-controller.git


The following commit(s) were added to refs/heads/master by this push:
     new 48c924c  docs: add pre-commit todo in the development guide (#907)
48c924c is described below

commit 48c924c3397f2a433482204934a37aac4c4726b8
Author: LetsGO <97...@qq.com>
AuthorDate: Wed Mar 9 09:43:53 2022 +0800

    docs: add pre-commit todo in the development guide (#907)
    
    * docs: add pre-commit todo in the development guide
    
    * fix: review
---
 docs/en/latest/development.md | 19 +++++++++++++++++++
 1 file changed, 19 insertions(+)

diff --git a/docs/en/latest/development.md b/docs/en/latest/development.md
index 080fd55..f31d514 100644
--- a/docs/en/latest/development.md
+++ b/docs/en/latest/development.md
@@ -103,3 +103,22 @@ Something you need to pay attention to:
 
 * configuring of `--kubeconfig`, if you are using Minikube, the file path should be `~/.kube/config`.
 * configuring of `--default-apisix-cluster-admin-key`, if you have changed the admin key in Apache APISIX, also changing it here. If you have disabled the authentication in Apache APISIX, just removing this option.
+
+## Pre-commit todo
+
+When everything is ready, before submitting the code, please make sure that the license, code style, and document format are consistent with the project specification.
+
+We provide commands to implement it, just run the following commands:
+
+```shell
+make update-codegen
+make update-license
+make update-gofmt
+make update-mdlint
+```
+
+or just run one command:
+
+```shell
+make update-all
+```