mirror of
https://github.com/PR0M3TH3AN/TORCH.git
synced 2026-10-27 07:51:52 +00:00
chore: Enforce Clean Repo Standard and organize artifacts
- Added "Clean Repo Standard" to `AGENTS.md` and `CLAUDE.md`, explicitly forbidding root-level logs/artifacts. - Moved clutter files (`test_output_full.txt`, `benchmark-after.txt`, `dashboard.log`, etc.) to `test_logs/`, `task-logs/`, and `reports/performance/`. - Moved `INITIAL_BASELINE.md` and other baseline files to `reports/performance/`. - Updated `src/prompts/daily/perf-agent.md` and `src/prompts/daily/const-refactor-agent.md` to reference the new location of `INITIAL_BASELINE.md`. - Updated `.gitignore` to ignore logs and temporary artifacts in the new directories. - Moved `DIAGNOSIS.md` to `reports/performance/`. - Moved `perf/` data files to `reports/performance/`. Co-authored-by: PR0M3TH3AN <[email protected]>
This commit is contained in:
1 parent
39a900a710
commit
326608ce7e
27 files changed
+49
-3
No files matched your search
+24
@@ -1,3 +1,27 @@
|
||||
node_modules
|
||||
dist/
|
||||
.scheduler-memory/
|
||||
|
||||
# Logs
|
||||
*.log
|
||||
npm-debug.log*
|
||||
yarn-debug.log*
|
||||
yarn-error.log*
|
||||
|
||||
# Test logs
|
||||
test_logs/*.log
|
||||
test_logs/*.txt
|
||||
|
||||
# Task logs
|
||||
task-logs/*.log
|
||||
|
||||
# Artifacts and temporary files
|
||||
artifacts/
|
||||
reports/performance/hits-*.json
|
||||
reports/performance/hits-*.txt
|
||||
reports/performance/benchmark-*.txt
|
||||
|
||||
# Root clutter prevention
|
||||
test_output_full.txt
|
||||
benchmark-after.txt
|
||||
benchmark-baseline.txt
|
||||
@@ -115,6 +115,22 @@ Its goal is “make the suite reflect reality and reject fake passes.”
|
||||
|
||||
---
|
||||
|
||||
## File Organization & Cleanliness (Clean Repo Standard)
|
||||
|
||||
Agents must keep the repository root clean. Do not create log files, temporary outputs, or artifacts in the root directory.
|
||||
|
||||
**Standard Locations:**
|
||||
|
||||
* **Reports**: `reports/<category>/` (e.g., `reports/performance/`, `reports/audit/`). See [Report Location Standard](#report-location-standard).
|
||||
* **Test Logs**: `test_logs/` (e.g., `test_logs/test_output_full.txt`).
|
||||
* **Task Logs**: `task-logs/` (e.g., `task-logs/daily/`).
|
||||
* **Artifacts**: `artifacts/` (for raw data, repros, or other artifacts).
|
||||
* **General Logs**: `logs/` (if needed, otherwise `task-logs/`).
|
||||
|
||||
**Prohibitions:**
|
||||
* No `*.log`, `*.txt`, `*.json`, or `*.md` files in the root directory (except standard docs like `README.md`, `AGENTS.md`, `CLAUDE.md`, `KNOWN_ISSUES.md`).
|
||||
* If a tool or script defaults to writing to root, redirect its output or configure it to write to one of the standard locations.
|
||||
|
||||
## Report Location Standard
|
||||
|
||||
All agents that generate reports must adhere to the following directory structure. Reports must be placed in `reports/<category>/`.
|
||||
|
||||
@@ -74,3 +74,9 @@ Prefer boundary-level service virtualization (“digital twins” / behavioral c
|
||||
* not rate-limited / not flaky
|
||||
|
||||
(StrongDM’s “Digital Twin Universe” is the reference pattern.) ([factory.strongdm.ai][2])
|
||||
|
||||
### Clean Repo Standard
|
||||
|
||||
* **No Root Clutter**: Do not create logs, artifacts, or temporary files in the repository root.
|
||||
* **Structured Output**: Use `reports/`, `test_logs/`, `task-logs/`, or `artifacts/` as appropriate.
|
||||
* **Redirect Output**: If a command writes to root, redirect it (e.g., `cmd > test_logs/output.txt`).
|
||||
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
@@ -176,7 +176,7 @@ DETAILED WORKFLOW (step-by-step)
|
||||
|
||||
9) **Follow-up**
|
||||
- Track PR reviews and address comments.
|
||||
- When merged, update `INITIAL_BASELINE.md` or a `perf/constants-refactor/history.md` to note the canonicalization for future audits.
|
||||
- When merged, update `reports/performance/INITIAL_BASELINE.md` or a `reports/performance/constants-refactor/history.md` to note the canonicalization for future audits.
|
||||
- If any replacement surfaced ambiguous semantics that required a behavior change, document in `src/decisions/DECISIONS_<timestamp>.md` and open an Issue for broader discussion.
|
||||
|
||||
- If no work is required, exit without making changes.
|
||||
|
||||
@@ -50,7 +50,7 @@ Commit early and often:
|
||||
- `src/todo/TODO_<timestamp>.md` — tasks (Done / Blocked).
|
||||
- `src/decisions/DECISIONS_<timestamp>.md` — design choices & rationale.
|
||||
- `src/test_logs/TEST_LOG_<timestamp>.md` — commands, env, outputs, failures.
|
||||
- `INITIAL_BASELINE.md` — baseline metrics (login time, decrypt queue size, relay latencies, webtorrent count).
|
||||
- `reports/performance/INITIAL_BASELINE.md` — baseline metrics (login time, decrypt queue size, relay latencies, webtorrent count).
|
||||
- `perf/` (optional) — scripts and small helpers.
|
||||
|
||||
Read `AGENTS.md` and `KNOWN_ISSUES.md` before edits.
|
||||
@@ -175,7 +175,7 @@ ESCALATION & RISK POLICY
|
||||
|
||||
-------------------------------------------------------------------------------
|
||||
FIRST-RUN CHECKLIST (execute now)
|
||||
1. Commit files in `src/context/`, `src/todo/`, `src/decisions/`, `src/test_logs/`, `INITIAL_BASELINE.md`.
|
||||
- Commit files in `src/context/`, `src/todo/`, `src/decisions/`, `src/test_logs/`, `reports/performance/INITIAL_BASELINE.md`.
|
||||
2. Run Search Patterns across repo and save `reports/performance/hits-YYYY-MM-DD.json`.
|
||||
3. Prioritize P0 findings, open at most 1–3 small PRs (bounded concurrency, worker queue limits, visibility gating).
|
||||
4. Audit `/content` upload pages: inventory claims → map to code → verify → open docs PR or issue.
|
||||
|
||||
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
Reference in new issue
Block a user