Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,8 +19,10 @@ npm install
| `npm run check` | Type-check without building |
| `npm run lint` | Run ESLint |
| `npm run format` | Format source with Prettier |
| `npm run audit:all` | Audit all dependencies, including development tooling |
| `npm test` | Run all tests |
| `npm run test:watch` | Run tests in watch mode |
| `npm run release:check` | Run the complete CI and release-readiness gate |

## Architecture

Expand Down Expand Up @@ -52,7 +54,7 @@ Test fixtures are in `fixtures/`. Add fixture directories for new test scenarios
## Pull Requests

- Keep PRs focused — one feature or fix at a time
- Ensure `npm test` passes and coverage thresholds are met
- Ensure `npm run release:check` passes
- Update docs if changing CLI behavior

## Code of Conduct
Expand Down
3 changes: 2 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -156,6 +156,7 @@ npm run release:check

The release gate covers:

- `npm run audit:all` - audit the complete dependency graph, including development tooling
- `npm run audit:prod` - audit shipped dependencies for known vulnerabilities
- `npm run check` - tsc --noEmit
- `npm run lint` - eslint src --ext .ts
Expand All @@ -164,7 +165,7 @@ The release gate covers:
- `npm run smoke` - npm run build && node dist/cli.js --help && node dist/cli.js fixtures --format text
- `npm run validate` - bash scripts/validate.sh
- `npm run package:smoke` - npm run build && node scripts/package-smoke.mjs
- `npm run release:check` - production audit, typecheck, lint, tests, smoke checks, and package smoke check
- `npm run release:check` - full and production audits, typecheck, lint, tests, smoke checks, and package smoke check

## Release readiness

Expand Down
Loading
Loading