Merge pull request #118 from linjie7674/ci/pre_commit_lint

ci: config code linter in pre-commit hook

.pre-commit-config.yaml

@@ -0,0 +1,11 @@
+repos:
+- repo: https://github.com/golangci/golangci-lint # golangci-lint hook repo
+ rev: v1.54.0 # golangci-lint hook repo revision
+ hooks:
+ - id: golangci-lint
+ name: golangci-lint
+ description: Fast linters runner for Go.
+ entry: golangci-lint run --fix
+ types: [go]
+ language: golang
+ pass_filenames: false

README.md

@@ -42,10 +42,20 @@ gop run .
 
 1. **Fork the repository to your local repo**
 
-2. **Modify your own code**
+2. **Config code linter**
+
+ ```bash
+ // install pre-commit
+ pip install pre-commit
 
-3. **Commit your code**
+ // config code linter in pre-commit hook
+ pre-commit install
+ ```
 
-4. **Create a pull request**
+3. **Modify your own code**
+
+4. **Commit your code**
+
+5. **Create a pull request**
 
 > **Note:** Please check the PR brach is `mvp-20240119` or not.