docs: align workflow agent competition materials

This commit is contained in:
whzy 2026-05-22 09:53:39 +08:00 committed by wbtiger
parent 2dc230430b
commit 018c08e178
3 changed files with 7 additions and 7 deletions

View File

@ -41,7 +41,7 @@ Planned next:
- Added local input support:
- `workflow +triage`: single issue flags or `--from` JSON file.
- `workflow +health`: explicit metric flags or `--from` JSON file.
- `workflow +pr-summary`: PR number fetch or `--from` JSON file.
- `workflow +pr-summary`: PR number fetch or `--from` JSON file.
- `workflow +repo-report`: aggregate health, issues, and PR list metadata or `--from` JSON file.
- Verified all three commands run locally without GitLink API write access.
- Added read-only workflow API fetch helpers and mock tests.
@ -194,7 +194,7 @@ Planned next:
## Next Minimal Executable Task
Create GitLink official PR and record CI result.
Create GitLink official PR, record CI result, and record demo video.
## How To Continue After Interruption
@ -209,4 +209,4 @@ Create GitLink official PR and record CI result.
## Recommended Next Codex Instruction
Create GitLink official PR from branch `codex/workflow-agent`, then record PR URL and CI result in `docs/final-submission-checklist.md`.
Create GitLink official PR from branch `codex/workflow-agent`, then record PR URL, CI result, and demo video status in `docs/final-submission-checklist.md`.

View File

@ -100,8 +100,6 @@ Coverage includes:
- `workflow +release-notes` is not implemented.
- `workflow +stale` is not implemented.
- Real GitLink API shapes may require follow-up normalization.
- Remote `workflow +repo-report` PR aggregation currently uses PR list metadata;
detailed changed-file and commit analysis is available through `workflow +pr-summary --number`.
## Examples

View File

@ -119,10 +119,11 @@ Rules:
- This command is read-only: it does not comment, approve, reject, merge, label, or close pull requests.
- Do not use LLM APIs for this workflow; it is rule-based and explainable.
## Workflow: Repository Report (Read-only)
## Workflow: Repo Report (Read-only)
Use `workflow +repo-report` when a maintainer or Agent needs a single repository workflow report
that aggregates health, issue triage, and PR review signals.
适用于需要生成仓库治理报告、比赛材料、维护者汇总或 Agent 综合分析的场景。
```bash
# Maintainer report
@ -132,13 +133,14 @@ gitlink-cli workflow +repo-report --owner Gitlink --repo gitlink-cli --format ma
gitlink-cli workflow +repo-report --owner Gitlink --repo gitlink-cli --format json
# Local fixture mode
gitlink-cli workflow +repo-report --from shortcuts/workflow/testdata/repo_report.json --format markdown
gitlink-cli workflow +repo-report --from shortcuts/workflow/testdata/repo_report.json --format json
```
Rules:
- Prefer `--format json` when another Agent consumes the output.
- Prefer `--format markdown` for maintainer reports, competition materials, and review handoff.
- Treat remote mode as read-only aggregation only.
- Do not perform remote write operations.
- Do not comment, label, close, approve, reject, or merge from this workflow.
- PR details in remote report mode may be partial; use `workflow +pr-summary --number <n>` for a focused PR review.