From ff17f0204d8b803779507ad15d069c7e451e4636 Mon Sep 17 00:00:00 2001 From: rcmerci Date: Fri, 9 Oct 2026 20:17:57 +0800 Subject: [PATCH] Rename Journal review skill and add UX review guidance --- .agents/skills/journal-code-review/SKILL.md | 27 +++++++++++++++++++ .../journal-code-review/agents/openai.yaml | 4 +++ .agents/skills/ocaml-review/SKILL.md | 14 ---------- 3 files changed, 31 insertions(+), 14 deletions(-) create mode 100644 .agents/skills/journal-code-review/SKILL.md create mode 100644 .agents/skills/journal-code-review/agents/openai.yaml delete mode 100644 .agents/skills/ocaml-review/SKILL.md diff --git a/.agents/skills/journal-code-review/SKILL.md b/.agents/skills/journal-code-review/SKILL.md new file mode 100644 index 0000000..ee28392 --- /dev/null +++ b/.agents/skills/journal-code-review/SKILL.md @@ -0,0 +1,27 @@ +--- +name: journal-code-review +description: 在请求审查 Journal 代码时使用，检查性能、UX 与类型约束。 +--- + +# Journal Code Review + +只读审查请求范围内的代码，只报告问题，不修改代码或其他文件。 + +## 性能 + +- 检查读写放大：单次操作是否重复全量读取、遍历或重写，结合数据量与调用频率判断影响。 +- `List` 仅用于明确小于 1000 项的数据，数量未知或可能 >= 1000 时应改用 `rrbvec`（已有依赖时使用 `Rrbvec` 向量），重点检查高频 `List.length`、`List.nth`、`List.append`、`List.concat` 等线性调用及重复拼接造成的 O(n²)。 + +## UX + +- 检查操作进度、结果与失败是否有清晰反馈。 +- 逐一检查所有可见按钮，点击必须有对应操作或明确反馈，不可操作时明确禁用并解释原因，不能静默无响应。 +- 检查取消、返回与退出是否可达且能安全结束当前操作。 +- 检查界面呈现与实际状态是否一致。 +- 检查关键操作的可访问性，包括语义标签、焦点顺序与辅助技术支持。 + +## type + +- 检查 `spec/` 下的 `.mli` 类型能否加强约束，以排除非法状态、区分身份与生命周期并限制构造权限。 + +仅报告有证据的问题，每点尽量一句，包含严重度、位置、触发条件与影响，并标明实证或推断；无发现时明确说明。 diff --git a/.agents/skills/journal-code-review/agents/openai.yaml b/.agents/skills/journal-code-review/agents/openai.yaml new file mode 100644 index 0000000..795c2e4 --- /dev/null +++ b/.agents/skills/journal-code-review/agents/openai.yaml @@ -0,0 +1,4 @@ +interface: + display_name: "Journal Code Review" + short_description: "只读审查 Journal 代码的性能、UX 与类型约束，仅报告有证据的问题" + default_prompt: "使用 $journal-code-review 只读审查指定范围，简短报告有证据的性能、UX 与类型问题。" diff --git a/.agents/skills/ocaml-review/SKILL.md b/.agents/skills/ocaml-review/SKILL.md deleted file mode 100644 index 021ac75..0000000 --- a/.agents/skills/ocaml-review/SKILL.md +++ /dev/null @@ -1,14 +0,0 @@ ---- -name: ocaml-review -description: review ocaml时使用 ---- - -# OCaml Review - -只读审查请求范围内的代码，只报告问题，不修改代码或其他文件。 - -1. 检查读写放大：单次操作是否重复全量读取、遍历或重写，结合数据量与调用频率判断影响。 -2. `List` 仅用于明确小于 1000 项的数据，数量未知或可能 >= 1000 时应改用 `rrbvec`（已有依赖时使用 `Rrbvec` 向量），重点检查高频 `List.length`、`List.nth`、`List.append`、`List.concat` 等线性调用及重复拼接造成的 O(n²)。 -3. 检查 `spec/` 下的 `.mli` 类型能否加强约束，以排除非法状态、区分身份与生命周期并限制构造权限。 - -仅报告有证据的问题，每点尽量一句，包含严重度、位置、触发条件与影响，并标明实证或推断；无发现时明确说明。