add AGENTS.md and CLAUDE.md, remove them from .gitignore (#5232)

This commit is contained in:
fatedier
2026-03-12 00:21:31 +08:00
committed by GitHub
parent 4f584f81d0
commit 6b1be922e1
3 changed files with 36 additions and 2 deletions

3
.gitignore vendored
View File

@@ -29,6 +29,5 @@ client.key
*.swp
# AI
CLAUDE.md
AGENTS.md
.claude/
.sisyphus/

34
AGENTS.md Normal file
View File

@@ -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`

1
CLAUDE.md Symbolic link
View File

@@ -0,0 +1 @@
AGENTS.md