diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index aaf5164..be798d5 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -9,6 +9,13 @@ This repository is designed for human and AI contributors. Keep contributions sm - Preserve existing behavior unless a change is explicitly requested. - Document assumptions and tradeoffs. +## Development Commands + +- **Install**: `npm install` +- **Test**: `npm test` +- **Lint**: `npm run lint` +- **Build**: `npm run build` + ## Standard contribution flow 1. Sync your branch with the target base branch. diff --git a/README.md b/README.md index 588298f..f0dae25 100644 --- a/README.md +++ b/README.md @@ -93,6 +93,8 @@ If you are developing `torch-lock` itself: - `npm run lock:check:weekly` - `npm run lock:list` - `npm run dashboard:serve` +- `npm test` (run unit tests) +- `npm run lint` (run linter) diff --git a/task-logs/daily/2026-02-14T19-25-45Z__docs-agent__completed.md b/task-logs/daily/2026-02-14T19-25-45Z__docs-agent__completed.md new file mode 100644 index 0000000..54175eb --- /dev/null +++ b/task-logs/daily/2026-02-14T19-25-45Z__docs-agent__completed.md @@ -0,0 +1,31 @@ +--- +agent: docs-agent +status: completed +cadence: daily +date: 2026-02-14 +--- + +# Documentation Audit Report + +## Summary +Audited `README.md` and `CONTRIBUTING.md`. Found that specific development commands (`npm test`, `npm run lint`) were not explicitly listed in the main documentation. Added them to ensure contributors can easily verify their changes. + +## Findings +- **README.md**: + - Missing `npm test` and `npm run lint` in "NPM Scripts" section. +- **CONTRIBUTING.md**: + - Generic. Missing specific commands for this repo. +- **docs/**: + - `docs/event-schemas.md` and `docs/runtime-fallback.md` are missing from the repository, so they could not be audited. + +## Actions Taken +- Updated `README.md` to list `npm test` (run unit tests) and `npm run lint` (run linter). +- Updated `CONTRIBUTING.md` to add a "Development Commands" section listing `npm install`, `npm test`, `npm run lint`, and `npm run build`. + +## Validation +- Ran `npm test`: Passed (61 tests). +- Ran `npm run lint`: Passed (with 8 warnings). +- Ran `npm run build`: Passed. + +## Next Steps +- Consider creating `docs/event-schemas.md` and `docs/runtime-fallback.md` or updating the audit scope if they are not needed.