mirror of
https://github.com/CJackHwang/ds2api.git
synced 2026-05-11 03:37:40 +08:00
37 lines
2.1 KiB
Markdown
37 lines
2.1 KiB
Markdown
# AGENTS.md
|
|
|
|
These rules apply to all agent-made changes in this repository.
|
|
|
|
## PR Gate
|
|
|
|
- Before opening or updating a PR, run the same local gates as `.github/workflows/quality-gates.yml`.
|
|
- Required commands:
|
|
- `./scripts/lint.sh`
|
|
- `./tests/scripts/check-refactor-line-gate.sh`
|
|
- `./tests/scripts/run-unit-all.sh`
|
|
- `npm run build --prefix webui`
|
|
|
|
## Go Lint Rules
|
|
|
|
- Run `gofmt -w` on every changed Go file before commit or push.
|
|
- Do not ignore error returns from I/O-style cleanup calls such as `Close`, `Flush`, `Sync`, or similar methods.
|
|
- If a cleanup error cannot be returned, log it explicitly.
|
|
|
|
## Change Scope
|
|
|
|
- Keep changes additive and tightly scoped to the requested feature or bugfix.
|
|
- Do not mix unrelated refactors into feature PRs unless they are required to make the change pass gates.
|
|
|
|
## Protocol Adapter Boundary
|
|
|
|
- Do not let OpenAI Chat, OpenAI Responses, Claude, Gemini, or other interface protocol formatting own shared business behavior.
|
|
- Normalize protocol-specific request shapes into the project standard request/turn model first, run shared business logic in one place, then render back to the target protocol at the boundary.
|
|
- Business logic that must stay globally consistent includes empty-output retry, thinking/reasoning handling, tool-call detection and policy, usage accounting, current-input-file injection, history persistence, file/reference handling, and completion payload assembly.
|
|
- If a behavior must differ by protocol, keep the difference as an explicit adapter/rendering concern and document why it cannot live in the shared normalized path.
|
|
|
|
## Documentation Sync
|
|
|
|
- When business logic or user-visible behavior changes, update the corresponding documentation in the same change.
|
|
- `docs/prompt-compatibility.md` is the source-of-truth document for the “API -> pure-text web-chat context” compatibility flow.
|
|
- If a change affects message normalization, tool prompt injection, prompt-visible tool history, file/reference handling, history split, or completion payload assembly, update `docs/prompt-compatibility.md` in the same change.
|