Skip to content

docs: run the actual skill suite in contributor test instructions #718

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Lum1104 merged 1 commit into from
Oct 9, 2026
+7 −5
Merged

docs: run the actual skill suite in contributor test instructions #718

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
12 changes: 7 additions & 5 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ Thank you for your interest in contributing to Understand Anything! This documen
4. **Run Tests**
```bash
pnpm --filter @understand-anything/core test
pnpm --filter @understand-anything/skill test
pnpm test
```

5. **Start Dashboard (Optional)**
Expand Down Expand Up @@ -70,7 +70,7 @@ git checkout -b docs/update-readme # For documentation
```bash
# Run all tests
pnpm --filter @understand-anything/core test
pnpm --filter @understand-anything/skill test
pnpm test

# Run linter
pnpm lint
Expand Down Expand Up @@ -145,16 +145,18 @@ describe('MyFeature', () => {
### Running Tests

```bash
# Run all tests
# Run skill and dashboard tests from the repository root
pnpm test

# Run tests for specific package
# Run core package tests (excluded from the root suite)
pnpm --filter @understand-anything/core test

# Run tests in watch mode
pnpm --filter @understand-anything/core test --watch
```

Run both commands for the complete test coverage used by CI. The root Vitest config covers `tests/skill/`, plugin source, and dashboard tests; it excludes the core package. The skill package's own `test` script only prints a reminder to run `pnpm test` from the repository root.

## 📚 Code Style Guidelines

### TypeScript
Expand Down Expand Up @@ -243,7 +245,7 @@ When requesting features:
Before submitting a PR, ensure:

- [ ] Code follows the project's style guidelines
- [ ] All tests pass (`pnpm test`)
- [ ] Core tests and root skill/dashboard tests pass (`pnpm --filter @understand-anything/core test` and `pnpm test`)
- [ ] New code has test coverage
- [ ] Documentation is updated (if needed)
- [ ] Commit messages follow convention
Expand Down