Skip to content

docs: Document code testing and coverage requirements for doc-detective-common#149

Open
promptless[bot] wants to merge 3 commits intomainfrom
promptless/document-code-testing-coverage
Open

docs: Document code testing and coverage requirements for doc-detective-common#149
promptless[bot] wants to merge 3 commits intomainfrom
promptless/document-code-testing-coverage

Conversation

@promptless
Copy link
Contributor

@promptless promptless bot commented Jan 7, 2026

Open this suggestion in Promptless to view citations and reasoning process

Updates contributor documentation for doc-detective-common to reflect the new testing and code coverage requirements introduced in PR #151. Contributors now need to maintain 100% code coverage across all metrics (lines, statements, functions, branches) with automated ratchet checks enforcing these thresholds in CI. The documentation includes test file locations, commands for running tests with coverage, and TDD workflow guidance.

Trigger Events


Help us improve Promptless — If this suggestion missed the mark, please share quick feedback.

If you want Promptless to make further changes on this PR, feel free to leave a comment tagging Promptless (It won't show up in the user drop down but Promptless will get it!)

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Jan 7, 2026

Important

Review skipped

Bot user detected.

To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.


Comment @coderabbitai help to get the list of available commands and usage tips.

@promptless
Copy link
Contributor Author

promptless bot commented Jan 17, 2026

I've added new changes to address this GitHub PR in commit 1f8783a

@promptless
Copy link
Contributor Author

promptless bot commented Jan 27, 2026

I've added new changes to address this GitHub PR in commit 4d18dd3


This repo doesn't depend on any other Doc Detective repos. No newline at end of file
This repo doesn't depend on any other Doc Detective repos.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Citation: Based on testing infrastructure added in PR #151, which introduced comprehensive code coverage tooling including c8, coverage-thresholds.json with 100% baseline thresholds, scripts/check-coverage-ratchet.js for ratchet enforcement, new test files (test/validate.test.js, test/resolvePaths.test.js), and npm scripts (test:coverage, test:coverage:ratchet, test:coverage:html). Also references CI/CD changes in .github/workflows/auto-dev-release.yml and .github/workflows/npm-test.yml.
View source

This repo doesn't depend on any other Doc Detective repos. No newline at end of file
This repo doesn't depend on any other Doc Detective repos.

## TypeScript codebase
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Citation: TypeScript migration PR describing the new codebase structure. Source files moved from .js to .ts, build process generates CommonJS, ESM, and TypeScript declarations in dist/. Tests remain JavaScript and run against compiled output. See PR description for build pipeline details and tsconfig.json for TypeScript configuration.
View source

| `src/validate.ts` | `test/validate.test.js` |
| `src/resolvePaths.ts` | `test/resolvePaths.test.js` |
| `src/files.ts` | `test/files.test.js` |

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Citation: Added src/schemas/index.tstest/schema.test.js mapping based on the merged TypeScript migration PR. The diff shows test/schema.test.js was updated alongside src/schemas/index.ts.
View source

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

0 participants