mirror of
https://github.com/gotenberg/gotenberg.git
synced 2026-08-08 00:22:14 +01:00
1.3 KiB
1.3 KiB
Claude Code — Gotenberg
Read AGENTS.md first. It contains the core principles, project layout, and links to specialized personas you must load depending on the task.
Quick Reference
- Format before committing:
make fmt(Go) andmake prettify(non-Go) - Lint before committing:
make lint && make lint-prettier - Commits must follow Conventional Commits (e.g.,
feat(chromium): add screenshot endpoint) - Run unit tests:
make test-unit - Run integration tests:
make build && make test-integration TAGS=<relevant-tag> - Never run
gocommands directly — use the Makefile.
Claude-Specific Guidance
- When exploring the codebase, start with
pkg/gotenberg/for core interfaces andpkg/modules/for feature implementations. - The integration test infrastructure in
test/integration/scenario/is well-structured — readscenario.goandcontainers.goto understand the Gherkin step definitions before writing new tests. - Mocks for all major interfaces are in
pkg/gotenberg/mocks.go— use them for unit tests rather than creating new ones. - Import ordering is enforced: standard library, third-party, then
github.com/gotenberg/gotenberg/v8— separated by blank lines. - When making changes, run only the relevant integration test tag rather than the full suite (40min timeout).