mirror of
https://github.com/BishopFox/sliver
synced 2026-06-08 10:29:05 +00:00
906 B
906 B
Repository Guidelines
Build, Test, and Development Commands
makebuilds server + client using vendored modules and runsgo-assets.sh.make clientbuilds a CGO-free client;make debugkeeps symbols.make pbregenerates protobuf stubs fromprotobuf/../go-tests.shruns the Go test suite, this is the only way you should run unit tests.- Docs site:
cd docs/sliver-docs && npm install && npm run devfor local dev;npm run buildfor a static build.
Coding Style & Naming Conventions
- Run
gofmton all Go code; keep package names lowercase and idiomatic. - Avoid
CGOand empty interfaces; prefer explicit types and interfaces. - Do not import
serverpackages fromclient.
Testing Guidelines
- Prefer
docker build --target test --build-arg GO_TESTS_FLAGS=--skip-generate . - Add or update tests when behavior changes; some server packages run longer tests.