|
| 1 | +# REQ - AGENTS.md problem discovery & fix reporting clause |
| 2 | + |
| 3 | +- Task ID: `2026-09-06_agents-md-problem-reporting` |
| 4 | +- Home Repo: `opencode-acp` |
| 5 | +- Created: 2026-09-06 |
| 6 | +- Status: InProgress |
| 7 | +- Priority: P2 |
| 8 | +- Owner: ranxianglei (agent) |
| 9 | +- References: https://github.com/ranxianglei/billion-context/issues/584 |
| 10 | + |
| 11 | +## 1. Background & Problem Statement |
| 12 | + |
| 13 | +- **Context**: Agents frequently discover problems while working, and fixes sometimes land without any issue tracking — the problem, its impact, and the fix rationale exist only in a chat thread or nowhere. |
| 14 | +- **Current behavior (symptom)**: AGENTS.md §5 covers workflow, git safety, and PR merge prohibition, but says nothing about problems discovered or fixed *along the way*; such fixes can be silent. |
| 15 | +- **Expected behavior**: A MANDATORY clause requires that every discovered problem is filed as an issue in the owning project, and every fix is followed by an issue recording the problem + fix (or a PR referencing its issue; issue first, then link). The clause references this project's GitHub address. |
| 16 | +- **Impact**: Traceability of all agent-driven fixes across the billion-context family. |
| 17 | + |
| 18 | +## 2. Reproduction (if applicable) |
| 19 | + |
| 20 | +N/A — documentation/policy change. |
| 21 | + |
| 22 | +## 3. Constraints & Non-Goals |
| 23 | + |
| 24 | +- **Constraints**: |
| 25 | + - Backward compatibility: none (docs only). |
| 26 | + - Performance requirements: n/a. |
| 27 | + - Resource limits: n/a. |
| 28 | +- **Non-Goals** (explicitly out of scope): no code changes; no CI enforcement (policy lives in AGENTS.md); sibling repos get equivalent clauses via their own PRs (billion-context, billion-context-pi). |
| 29 | + |
| 30 | +## 4. Acceptance Criteria (must be testable) |
| 31 | + |
| 32 | +- **Correctness**: |
| 33 | + - [x] AGENTS.md §5 contains a new subsection "5.1.3 Problem Discovery & Fix Reporting (MANDATORY)" covering both cases: discovered-but-unfixed → file issue; fixed → issue after fix, or PR referencing its issue (`Fixes #N`). |
| 34 | + - [x] Clause references https://github.com/ranxianglei/opencode-acp/issues . |
| 35 | + - [x] `./scripts/ci/check-pr.sh` passes on this branch (branch name + devlog presence). |
| 36 | +- **Performance / Stability**: n/a. |
| 37 | +- **Regression**: |
| 38 | + - [x] No code changes — no test suite impact. |
| 39 | + |
| 40 | +## 5. Proposed Approach (optional) |
| 41 | + |
| 42 | +- **Affected modules & entry files**: |
| 43 | + - `AGENTS.md` — new subsection §5.1.3 under §5 Contributing, between §5.1.2 (Devlog Requirement) and §5.2 (After Making Changes). |
| 44 | +- **Risks**: None (documentation). |
| 45 | +- **Rollback strategy**: Revert the single docs commit. |
0 commit comments