Skip to content
This repository was archived by the owner on Jun 2, 2026. It is now read-only.

Commit f17901e

Browse files
committed
Document the CLI wrapper package layout
1 parent 4dca88d commit f17901e

1 file changed

Lines changed: 9 additions & 0 deletions

File tree

CONTRIBUTING.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,15 @@ Use `make test` to make sure all tests pass before pushing.
1010

1111
Use `make lint` to make sure lint check passes before pushing.
1212

13+
## Packaging layout
14+
15+
The main package, `defectdojo-api-generated`, is intentionally library-only.
16+
It does not publish console scripts and should remain installable without CLI-only dependencies.
17+
18+
The `dojo` entrypoint lives in the thin wrapper package under `packages/cli/`.
19+
That package depends on the main library plus the CLI stack and should stay small:
20+
keep CLI packaging, entrypoints, and CLI-only dependency wiring there, while the actual CLI implementation can continue to live under `defectdojo_api_generated/cli/`.
21+
1322
## Guidelines
1423

1524
### Update openapi-generator version

0 commit comments

Comments
 (0)