Skip to content

Commit 5e6f823

Browse files
author
ework-agent
committed
docs: AGENTS.md — require issue tracking for discovered/fixed problems
1 parent 9b7adfd commit 5e6f823

3 files changed

Lines changed: 103 additions & 0 deletions

File tree

‎AGENTS.md‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -566,6 +566,13 @@ Every PR MUST have a corresponding devlog entry in `devlog/{YYYY-MM-DD_short-tit
566566

567567
See `devlog/README.md` for templates and naming conventions.
568568

569+
### 5.1.3 Problem Discovery & Fix Reporting (MANDATORY)
570+
571+
Problems discovered or fixed while working MUST leave a trace in the issue tracker — never fixed silently and moved on.
572+
573+
1. **Discovered a problem** (bug, defect, wrong behavior, spec violation) — whether while working on this project or any sibling project — file an issue in the project the problem belongs to: repro/steps, impact, root cause (if known), suggested fix.
574+
2. **Fixed a problem** — after the fix, submit an issue to the owning project recording the problem and how it was fixed. For problems in this project: https://github.com/ranxianglei/opencode-acp/issues . If the fix ships as a PR, the PR MUST reference its issue (`Fixes #N`); a bare PR without an issue is not acceptable — file the issue first, then link it. An existing PR for the fix counts, but it should carry an accompanying issue.
575+
569576
### 5.2 After Making Changes
570577

571578
1. `npm run build` must pass
Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
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.
Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
# WORKLOG - AGENTS.md problem discovery & fix reporting clause
2+
3+
- Task ID: `2026-09-06_agents-md-problem-reporting`
4+
- Home Repo: `opencode-acp`
5+
- Status: Done
6+
- Updated: 2026-09-06 22:25
7+
8+
## 1. Summary
9+
10+
- **What was done**: Added a MANDATORY subsection "5.1.3 Problem Discovery & Fix Reporting" to AGENTS.md §5 requiring issue tracking for every discovered problem and for every fix (issue first, PR references it via `Fixes #N`).
11+
- **Why** (sibling of issue ranxianglei/billion-context#584): fixes discovered/made by agents were not required to leave a trace in the project's issue tracker; the clause makes that mandatory and points at this project's GitHub address.
12+
- **Behavior / compatibility changes**: No (documentation only).
13+
- **Risk level**: Low.
14+
15+
## 2. Change Log
16+
17+
### Commits
18+
19+
| Commit | Description |
20+
|--------|-------------|
21+
| head of this branch | docs: AGENTS.md — require issue tracking for discovered/fixed problems |
22+
23+
### Key Files
24+
25+
- `AGENTS.md` — new subsection §5.1.3 under §5 Contributing, between §5.1.2 (Devlog Requirement) and §5.2 (After Making Changes).
26+
- `devlog/2026-09-06_agents-md-problem-reporting/REQ.md`, `WORKLOG.md` — this entry (required by pr-checks CI).
27+
28+
## 3. Design & Implementation Notes
29+
30+
- Clause covers both directions requested in the source issue: (a) problem discovered (in this project or a sibling) → file an issue in the owning project; (b) problem fixed → after the fix, submit an issue recording problem + fix, or ship the PR referencing its issue (`Fixes #N`) — a bare PR without an issue is not acceptable; an existing PR counts but should carry an accompanying issue.
31+
- References https://github.com/ranxianglei/opencode-acp/issues per "agents.md 引用对应的项目地址".
32+
33+
## 4. Testing & Verification
34+
35+
### Build & Test Commands
36+
37+
```sh
38+
./scripts/ci/check-pr.sh 2026-09-06_agents-md-problem-reporting origin/master
39+
```
40+
41+
Docs-only change — build/test suite not required.
42+
43+
### Results
44+
45+
- **PASS/FAIL**: PASS (check-pr.sh: branch name + devlog presence verified).
46+
47+
## 5. Risk Assessment & Rollback
48+
49+
- **Risk points**: none.
50+
- **Rollback method**: revert the single docs commit.
51+
- **Compatibility notes**: No.

0 commit comments

Comments
 (0)