Skip to content

docs: document all test scripts in test/README.md - #2807

Closed
bigtex79 wants to merge 1 commit into
bmad-code-org:mainfrom
bigtex79:docs/document-missing-test-files
Closed

docs: document all test scripts in test/README.md#2807
bigtex79 wants to merge 1 commit into
bmad-code-org:mainfrom
bigtex79:docs/document-missing-test-files

Conversation

@bigtex79

@bigtex79 bigtex79 commented Sep 1, 2026

Copy link
Copy Markdown

What

test/README.md only documented 2 of the 13 test scripts that currently exist under test/ (plus its fixtures and the separate adversarial-review eval suite). This adds a short entry for each undocumented script and fixture directory.

Why

Several test files (channel resolution, source URL parsing, rehype plugins, shim policy, site URL, template sync, published implementation model, skill validation, workflow path regex, and the build-auto renderer) had no description in the README, making it hard to know what coverage already exists before adding new tests.

How

  • Added a ### <Name> section with file path and one-line description for each undocumented test/*.js and test/*.mjs script
  • Added test/fixtures/validate-skills/ to the fixtures tree (was missing)
  • Linked to test/adversarial-review-tests/README.md for the separate manual eval suite
  • Added npm test to Quick Start alongside the existing npm run quality

Testing

Ran npm run lint:md and the full npm test suite (via the repo's pre-commit hook) — both pass. This is a documentation-only change with no code modifications.

@greptile-apps

greptile-apps Bot commented Sep 1, 2026

Copy link
Copy Markdown
Contributor

Greptile Summary

The PR expands test/README.md to catalog the repository's test scripts and fixtures, link the manual adversarial-review suite, and add npm test to the quick-start commands.

  • Documents ten previously omitted test scripts and their coverage.
  • Adds the skill-validation fixtures to the fixture tree.
  • Links the separately run adversarial-review evaluation suite.
  • Describes npm test as the full suite, although two documented scripts are not included in that command.

Confidence Score: 4/5

The PR appears safe to merge, with a non-blocking documentation correction needed to avoid presenting an incomplete command as the full test suite.

The documented files, fixtures, link, and suite descriptions are accurate, but npm test does not execute the newly documented rehype-plugin and workflow-path-regex tests.

Files Needing Attention: test/README.md

Important Files Changed

Filename Overview
test/README.md The new test catalog is otherwise accurate, but the quick-start section overstates the coverage provided by npm test.
Prompt To Fix All With AI
### Issue 1
test/README.md:11-12
**Full suite claim omits tests**

`npm test` does not execute the newly documented rehype-plugin and workflow-path-regex tests, so describing it as the full test suite gives contributors and CI users an inaccurate picture of which coverage has passed.

```suggestion
# Run the npm test suite
npm test
```

---

For each issue above, determine whether it is valid and should be fixed. If so, fix it directly.

Reviews (1): Last reviewed commit: "docs: document all test scripts in test/..." | Re-trigger Greptile

Comment thread test/README.md
Comment on lines +11 to +12
# Run the full test suite
npm test

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

P2 Full suite claim omits tests

npm test does not execute the newly documented rehype-plugin and workflow-path-regex tests, so describing it as the full test suite gives contributors and CI users an inaccurate picture of which coverage has passed.

Suggested change
# Run the full test suite
npm test
# Run the npm test suite
npm test
Prompt To Fix With AI
This is a comment left during a code review.
Path: test/README.md
Line: 11-12

Comment:
**Full suite claim omits tests**

`npm test` does not execute the newly documented rehype-plugin and workflow-path-regex tests, so describing it as the full test suite gives contributors and CI users an inaccurate picture of which coverage has passed.

```suggestion
# Run the npm test suite
npm test
```

---

For each issue above, determine whether it is valid and should be fixed. If so, fix it directly.

@coderabbitai

coderabbitai Bot commented Sep 1, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Team

Run ID: 99f14ebe-968d-48d7-8080-e903e50af196

📥 Commits

Reviewing files that changed from the base of the PR and between bd7ee16 and 33154e5.

📒 Files selected for processing (1)
  • test/README.md

Included review availability: Your plan provides up to 10 included reviews per hour; 9 remain after this review.


📝 Walkthrough

Walkthrough

The test README now documents the full test command, eleven additional test suites, and the validate-skills/ fixture directory.

Changes

Test Documentation

Layer / File(s) Summary
Document test execution and coverage
test/README.md
The README adds npm test, describes eleven additional test suites, and lists the validate-skills/ fixtures directory.

Estimated code review effort: 1 (Trivial) | ~2 minutes

Merge Risk: ⚪ Minimal · up to 33154

This documentation-only change adds descriptions for existing test scripts and fixtures without modifying runtime or product behavior; no actionable merge-blocking risk remains beyond normal checks and review.

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description check ✅ Passed The description clearly explains the documentation changes, their purpose, implementation, and testing results.
Title check ✅ Passed The title clearly and concisely identifies the main change: documenting all test scripts in test/README.md.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0…
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
Full details: Docstring Coverage

Explanation

No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0 files. (1 skipped: 1 unsupported.)

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

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

@alexeyv alexeyv closed this Sep 1, 2026
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.

2 participants