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
9 changes: 9 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -127,6 +127,9 @@ Before opening a PR, run the quick confidence suite:
$ npm run pr:check
```

<<<<<<< HEAD
This command runs the maintained contributor confidence suite: targeted lint checks, targeted TypeScript typechecking, and focused regression tests for the current contribution slice.
=======
This command runs issue-slice lint checks, issue-slice TypeScript typechecking, and the focused regression test suite used for this contribution wave.
## Architecture Decisions

Expand All @@ -142,6 +145,7 @@ We use standardized GitHub issue templates to keep triage fast and consistent. P
- Tech debt: for shortcuts, brittle patterns, dependency alignment, or missing safeguards that reduce engineering velocity or increase risk over time.

Blank issues are disabled so requests consistently include the details reviewers need to triage, scope, and ship changes safely.
>>>>>>> 19a7b48f152c83b373dd40836b279bc02c65038e


---
Expand All @@ -154,6 +158,11 @@ We heavily value test coverage to ensure marketplace stability.
# Run the quick pre-PR confidence suite
$ npm run pr:check

# Run individual parts of the confidence suite
$ npm run lint:pr
$ npm run typecheck:pr
$ npm run test:pr

# Run the unit test suite
$ npm run test

Expand Down
5 changes: 3 additions & 2 deletions docs/pr-checklist.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ Purpose: ensure consistent quality, prevent regressions, and make reviews faster

## Required items

- Quick confidence suite: run `npm run pr:check` before opening the PR so the maintained issue-slice lint, typecheck, and focused regression test all pass together.
- Quick confidence suite: run `npm run pr:check` before opening the PR so the maintained contributor lint, typecheck, and focused regression test suite all pass together.
- Tests: include unit and/or integration tests that cover the change. For bug fixes, add regression tests.
- Migrations: if schema or data changes are required, add migration files and clear instructions on applying/rolling back.
- Documentation: update `README.md`, `docs/`, module-level docs, or generated API docs for any user-facing or developer-facing change.
Expand All @@ -32,7 +32,8 @@ Purpose: ensure consistent quality, prevent regressions, and make reviews faster

## Testing guidance

- Use `npm run pr:check` as the default pre-PR command for fast confidence on the maintained issue slice.
- Use `npm run pr:check` as the default pre-PR command for fast confidence on the maintained contributor suite.
- Keep the focused `lint:pr`, `typecheck:pr`, and `test:pr` targets in sync when adding or replacing the files covered by the pre-PR suite.
- Unit tests should be fast (<100ms each) and deterministic.
- Integration/e2E tests should run in CI; local runs should be possible with the `local-dev` docker profile.

Expand Down
Loading
Loading