thePR0M3TH3AN/TORCH
1
0 Fork 0
mirror of https://github.com/PR0M3TH3AN/TORCH.git synced 2026-10-27 07:51:52 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs(docs-agent): audit and update development commands

Browse Source 
- Updated README.md to include `npm test` and `npm run lint` in NPM Scripts.
- Updated CONTRIBUTING.md to add a Development Commands section.
- Created task completion log.

Co-authored-by: PR0M3TH3AN <[email protected]>
This commit is contained in:
google-labs-jules[bot]andPR0M3TH3AN committed 2026-02-14 19:30:04 +00:00
1 parent 1d0fa2cdf5
commit 50f535aac0
3 files changed
+40
Download Patch File Download Diff File Expand all files Collapse all files

No files matched your search

CONTRIBUTING.md
+7
View File
@@ -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.
README.md
+2
View File
@@ -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)
task-logs/daily/2026-02-14T19-25-45Z__docs-agent__completed.md
+31
View File
@@ -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.