Browse Source

docs: configure engineering agent skills

Kazerin 2 tuần trước cách đây
mục cha
commit
6a666585f6
4 tập tin đã thay đổi với 81 bổ sung0 xóa
  1. 15 0
      AGENTS.md
  2. 36 0
      docs/agents/domain.md
  3. 19 0
      docs/agents/issue-tracker.md
  4. 11 0
      docs/agents/triage-labels.md

+ 15 - 0
AGENTS.md

@@ -0,0 +1,15 @@
+# 项目协作规则
+
+## Agent skills
+
+### Issue tracker
+
+Issues are tracked infrequently in the internal Gogs Issues through its web interface. See `docs/agents/issue-tracker.md`.
+
+### Triage labels
+
+Use the five default triage labels. See `docs/agents/triage-labels.md`.
+
+### Domain docs
+
+Use the multi-context layout. See `docs/agents/domain.md`.

+ 36 - 0
docs/agents/domain.md

@@ -0,0 +1,36 @@
+# Domain Docs
+
+This repository uses a multi-context domain documentation layout.
+
+## Before exploring
+
+Read the root `CONTEXT-MAP.md`, then read the `CONTEXT.md` files for relevant
+Maven modules. Read system-wide ADRs under `docs/adr/` and module-specific ADRs
+under `<module>/docs/adr/`.
+
+If these files do not exist, proceed silently. Domain-modeling skills create
+them lazily when terminology or decisions are resolved.
+
+## Layout
+
+```text
+/
+|-- CONTEXT-MAP.md
+|-- docs/adr/
+|-- pipe-network-service/CONTEXT.md
+|-- environment-service/CONTEXT.md
+|-- zk-gateway/CONTEXT.md
+|-- zk-common/CONTEXT.md
+|-- zk-api-service/CONTEXT.md
+|-- manhole-service/CONTEXT.md
+|-- firefighting-pressure-service/CONTEXT.md
+|-- flammable-gas-service/CONTEXT.md
+|-- telemetry-service/CONTEXT.md
+|-- radar-service/CONTEXT.md
+|-- audio-service/CONTEXT.md
+`-- water-level-service/CONTEXT.md
+```
+
+Each module may store scoped decisions under `<module>/docs/adr/`. Use the
+terminology defined by the relevant context consistently. Explicitly flag any
+proposal that conflicts with an existing ADR.

+ 19 - 0
docs/agents/issue-tracker.md

@@ -0,0 +1,19 @@
+# Issue tracker: Gogs
+
+Issues and specs for this repository live in the internal Gogs Issues:
+
+- `http://192.168.110.30:3000/shaoy/pipe-ner-server/issues`
+
+## Workflow
+
+Issue tracking is used infrequently in the current project workflow. Create, read,
+comment on, label, and close issues manually through the Gogs web interface.
+No CLI or API integration is assumed.
+
+When a skill says to publish to the issue tracker, prepare the title, body, and
+labels, then create the issue through Gogs. When a skill says to fetch a ticket,
+open the referenced Gogs issue and read its description, labels, and comments.
+
+## Pull requests as a triage surface
+
+Pull requests are not a request or triage surface.

+ 11 - 0
docs/agents/triage-labels.md

@@ -0,0 +1,11 @@
+# Triage Labels
+
+| Canonical role    | Gogs label        | Meaning                                |
+| ----------------- | ----------------- | -------------------------------------- |
+| `needs-triage`    | `needs-triage`    | Maintainer needs to evaluate the issue |
+| `needs-info`      | `needs-info`      | Waiting for more information           |
+| `ready-for-agent` | `ready-for-agent` | Fully specified and ready for an agent |
+| `ready-for-human` | `ready-for-human` | Requires human implementation          |
+| `wontfix`         | `wontfix`         | Will not be actioned                   |
+
+When a skill names a canonical role, use the corresponding Gogs label.