docs: add pre-commit todo in the development guide (#907)

* docs: add pre-commit todo in the development guide * fix: review
apache · Mar 9, 2022 · 48c924c · 48c924c
1 parent 1159522
commit 48c924c
Showing 1 changed file with 19 additions and 0 deletions.
diff --git 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
+```