From 6b1be922e155def020e78aa78f4b796b7a530ea4 Mon Sep 17 00:00:00 2001 From: fatedier Date: Thu, 12 Mar 2026 00:21:31 +0800 Subject: [PATCH] add AGENTS.md and CLAUDE.md, remove them from .gitignore (#5232) --- .gitignore | 3 +-- AGENTS.md | 34 ++++++++++++++++++++++++++++++++++ CLAUDE.md | 1 + 3 files changed, 36 insertions(+), 2 deletions(-) create mode 100644 AGENTS.md create mode 120000 CLAUDE.md diff --git a/.gitignore b/.gitignore index fdb32dc3..47fb34ad 100644 --- a/.gitignore +++ b/.gitignore @@ -29,6 +29,5 @@ client.key *.swp # AI -CLAUDE.md -AGENTS.md +.claude/ .sisyphus/ diff --git a/AGENTS.md b/AGENTS.md new file mode 100644 index 00000000..4f3e66e8 --- /dev/null +++ b/AGENTS.md @@ -0,0 +1,34 @@ +# AGENTS.md + +## Development Commands + +### Build +- `make build` - Build both frps and frpc binaries +- `make frps` - Build server binary only +- `make frpc` - Build client binary only +- `make all` - Build everything with formatting + +### Testing +- `make test` - Run unit tests +- `make e2e` - Run end-to-end tests +- `make e2e-trace` - Run e2e tests with trace logging +- `make alltest` - Run all tests including vet, unit tests, and e2e + +### Code Quality +- `make fmt` - Run go fmt +- `make fmt-more` - Run gofumpt for more strict formatting +- `make gci` - Run gci import organizer +- `make vet` - Run go vet +- `golangci-lint run` - Run comprehensive linting (configured in .golangci.yml) + +### Assets +- `make web` - Build web dashboards (frps and frpc) + +### Cleanup +- `make clean` - Remove built binaries and temporary files + +## Testing + +- E2E tests using Ginkgo/Gomega framework +- Mock servers in `/test/e2e/mock/` +- Run: `make e2e` or `make alltest` diff --git a/CLAUDE.md b/CLAUDE.md new file mode 120000 index 00000000..47dc3e3d --- /dev/null +++ b/CLAUDE.md @@ -0,0 +1 @@ +AGENTS.md \ No newline at end of file