docs: add descriptive instructions to Code Quality section
- Add requirement to run formatting before submitting code updates - Emphasize that go fmt must be run before committing changes - Clarify that formatting ensures consistent code formatting Generated with [codeagent](https://github.com/qbox/codeagent) Co-authored-by: xgopilot <noreply@goplus.org>
This commit is contained in:
@@ -70,11 +70,15 @@ go test ./...
|
|||||||
|
|
||||||
## Code Quality
|
## Code Quality
|
||||||
|
|
||||||
|
Before submitting any code updates, you must run the following formatting and validation commands:
|
||||||
|
|
||||||
### Format code
|
### Format code
|
||||||
```bash
|
```bash
|
||||||
go fmt ./...
|
go fmt ./...
|
||||||
```
|
```
|
||||||
|
|
||||||
|
**Important:** Always run `go fmt ./...` before committing code changes. This ensures consistent code formatting across the project.
|
||||||
|
|
||||||
### Run static analysis
|
### Run static analysis
|
||||||
```bash
|
```bash
|
||||||
go vet ./...
|
go vet ./...
|
||||||
|
|||||||
Reference in New Issue
Block a user