mirror of
https://github.com/gofiber/fiber.git
synced 2025-05-31 11:52:41 +00:00
Update AGENTS.md
This commit is contained in:
parent
22c3c0ced9
commit
b6f077275f
23
AGENTS.md
23
AGENTS.md
@ -2,16 +2,16 @@
|
||||
|
||||
## Agent Instructions
|
||||
|
||||
> **Note for the AI agent:** Before running the startup script, check for a `vendor` directory. If it exists, skip fetching modules; otherwise proceed. This vendor-check logic is for the agent’s decision-making and is not part of the user-facing script.
|
||||
> **Note for the AI agent:** Before running the startup script, verify that all dependencies and CLI tools are already available. If a `vendor/` directory exists **or** `go list -m -mod=readonly all` succeeds (indicating modules are cached), you may skip the entire startup script—including all `go mod` commands and `go install` steps. Otherwise run the script as listed below.
|
||||
|
||||
---
|
||||
|
||||
## Startup script
|
||||
## Startup script (reference only – do not run)
|
||||
|
||||
- Fetch dependencies:
|
||||
|
||||
```bash
|
||||
go get ./...
|
||||
go mod tidy && go mod download && go mod vendor
|
||||
```
|
||||
|
||||
- Install CLI tools referenced in Makefile:
|
||||
@ -25,3 +25,20 @@
|
||||
go install github.com/dkorunic/betteralign/cmd/betteralign@latest # struct alignment
|
||||
go mod tidy # clean up go.mod & go.sum
|
||||
```
|
||||
|
||||
## Makefile commands
|
||||
|
||||
Use `make help` to list all available commands. Common targets include:
|
||||
|
||||
- **audit**: run `go mod verify`, `go vet`, and `govulncheck` for quality checks.
|
||||
- **benchmark**: run benchmarks with `go test`.
|
||||
- **coverage**: generate a coverage report.
|
||||
- **format**: apply formatting using `gofumpt`.
|
||||
- **lint**: execute `golangci-lint`.
|
||||
- **test**: run the test suite with `gotestsum`.
|
||||
- **longtest**: run the test suite 15 times with shuffling enabled.
|
||||
- **tidy**: clean and tidy dependencies.
|
||||
- **betteralign**: optimize struct field alignment.
|
||||
- **generate**: run `go generate` after installing msgp and ifacemaker.
|
||||
|
||||
These targets can be invoked via `make <target>` as needed during development and testing.
|
||||
|
Loading…
x
Reference in New Issue
Block a user