sqhh99/point/project-records

Claude Code and agent skill by sqhh99/point

Trust tier 3
  • community
Source check pending

Checking that the SKILL.md file is still in the repository.

为 Point 写必备的项目记录——改动文件后的工作日志、审查代码后的审查归档、开 PR 前的 PR 记录。完成这三类事情时必须使用。

Install

npx vskill@latest install sqhh99/point/project-records

SKILL.md

项目记录

Point 在 docs/ 下保留三类永久记录。它们是必做项,不是可选的附加物:只存在于对话里的决定,会话一结束就丢了。用户不看 PR,只在用完软件后提意见,所以这些记录就是项目唯一可追溯的过程依据。

三类记录

记录何时写目录谁写
工作日志任何改动仓库文件的请求docs/work-logs/做改动的 bot
代码审查每次审查 PRdocs/code-reviews/PR评审员
PR 记录开 PR 之前docs/pull-requests/开 PR 的 bot
  • 记录用中文写;用户原话按原文引用。
  • 文件名统一 YYYY-MM-DD-<topic>.md,<topic> 是短的 kebab-case;PR 记录用分支主题。日期写绝对日期(2026-10-12),不写「今天」「上周」。
  • 同一件事的三份记录互相链接:日志链到审查和 PR 记录,审查的状态摘要链回日志,PR 记录链到前两者。用仓库内相对路径(../work-logs/...),保证在 GitHub 上能点开。
  • 记录随它描述的改动放在同一个 PR 里提交。审查记录由 PR评审员 在审查时另开一个只改 docs/code-reviews/ 的小 PR,或直接推到被审 PR 的分支上(作者同意时)。

通用规则

  • 没跑过的命令绝不打勾。 留空,并在旁边写明原因。这是最容易被悄悄破坏的一条,破坏了它,其他记录都不可信。
  • 明确写出验证状态,包括「未构建、未测试」。两个平台的 CI 结果写清楚是哪个 commit、哪几个 job。
  • 写清没做什么、没覆盖什么,和做了什么一样仔细。范围边界是后来的人最难还原的部分。
  • 版本号:功能或修复 PR 要写明这次按 va.b.c 规则升了哪一位以及理由(a:大升级或架构调整;b:较大的功能调整或优化;c:bug 修复或小优化)。文档、设计稿 PR 写「不升版本」。
  • AI 声明:写明哪些部分由哪个 bot 生成,是否经过验证。

1. 工作日志 — docs/work-logs/YYYY-MM-DD-<topic>.md

每个改动文件的请求写一份,覆盖「请求 → 计划 → 改动」全过程。同一天对同一请求的直接追加,在当天文件里加一节。

markdown
# 工作日志:<一句话主题>
-**日期:** YYYY-MM-DD
-**分支:** `<branch>`(从 `main` 的 `<commit>` 拉出)
-**执行者:** <bot 名>
-**相关记录:** 审查归档 / PR 记录的链接
## 1. 请求
> 用户或 bot 的原话
这个请求实际要什么,一两句话。
## 2. 计划
按实际执行顺序列出步骤。
## 3. 改动的文件
| 文件 | 改动 | 对应的需求 |
每个文件写清为什么改,不只是改了什么。
## 4. 验证
跑了什么、没跑什么、为什么。没跑就直说。
## 5. 遗留事项
没做完、没覆盖、需要后续跟进的。

2. 代码审查 — docs/code-reviews/YYYY-MM-DD-<short-title>.md

每次审查 PR 后写,无论有没有因此修改。

markdown
# <标题> 代码审查
-**日期:** YYYY-MM-DD
-**PR:** #<n>,审查时的 commit `<sha>`
-**范围:** 读了什么、怎么读的(读源码、追调用链、跑 CI / 本地运行)
-**未覆盖:** 有意没看的部分
## 状态摘要
一段话说明问题是否已处理,加上问题表。
| # | 问题 | 严重度 | 是否已处理 |
|---|------|--------|------------|
| 1 | ... | 中 | ❌ 未处理 / ✅ 已处理 — YYYY-MM-DD |
## 合并门禁
两个平台 CI、阻塞讨论、版本号、安全门禁各自的结果。
## <n>. <问题标题>
**位置:** `file:line` · **严重度:** ... · **是否已处理:** ...
哪里有问题、什么路径会触发、实际有多容易触发——如实写,不夸大严重度。
**修复:** 处理后补上,描述实际改动而不是意图。
## 确认无误——不要「修」这些
看起来像缺陷但其实处理正确的地方,防止以后被人改坏。

「是否已处理」这一列是这份文档的意义所在,要保持最新。问题后来被修了,就原地更新这份文件,不为同一次审查另开第二份。行号保留审查时的值,表头记了 commit。

3. PR 记录 — docs/pull-requests/YYYY-MM-DD-<branch-topic>.md

开 PR 之前写好,然后直接用作 PR 正文。

markdown
# PR:<标题>
-**日期:** / **分支:** `<branch>` → `main` / **基线 commit:** `<sha>` / **相关记录:**
## 关联
关联的 Issue 或要解决的问题(写「Related to #123」)。
## 改了什么
用户或开发者会注意到的变化,不要只贴文件列表。
## 改动类型
-[ ] Bug 修复
-[ ] 新功能
-[ ] 性能或重构(不改变行为)
-[ ] 仅文档、CI 或构建
## 版本号
升了哪一位、理由;或「不升版本」。
## 如何测试
-[ ] `pnpm lint` 和 `pnpm typecheck` 通过
-[ ] `pnpm test` 通过(core + main)
-[ ] `pnpm e2e` 通过
-[ ] Windows 和 macOS 上的 CI 全绿(写明 commit)
-[ ] 在应用里实际走过受影响的流程(写明是哪个)
没跑的项留空,写明原因,以及合并前谁、在哪个环境里跑。
## 检查项
-[ ] UI 改动附了改前改后截图,放在 `docs/pull-requests/assets/<文件名>/`
-[ ] 数据库表结构变化附了迁移脚本和迁移测试
-[ ] 打包布局、依赖、安全相关(CSP、IPC、外部内容渲染)变化在上面单独说明
-[ ] AI 声明:哪些部分由哪个 bot 生成,是否验证

PR 正文和这份文件内容要一致。

扩展这个 skill

新增一类记录需要三样东西:触发时机、docs/ 下的目录、这里的模板。在上面的表里加一行、加一个编号章节,再在根目录 AGENTS.md 的「必备记录」里加上触发条件,这样不读本文件也能知道要写。保持 YYYY-MM-DD-<topic>.md 命名,目录才能按日期排序和检索。

Security

  • Security scanPassed, 90 of 100Pattern checks on the skill's files.
  • Model reviewPassed

Quality evaluation

  • Task evaluationNot runNo evaluation yet. Run one in Skill Studio.

Source

Popularity

7-day trend score
0

Not refreshed yet.

Works with

Any agent vskill installs to: 56 targets in all. These 39 have a page on this site.

  • Claude Code
  • Cursor
  • GitHub Copilot
  • Windsurf
  • Codex
  • Gemini CLI
  • Cline
  • Amp
  • Roo Code
  • Goose
  • Continue
  • Kilo Code
  • Junie
  • Trae
  • OpenHands
  • Qwen Code
  • AI Agent
  • Tabnine Chat
  • Sourcegraph Cody
  • Amazon Q
  • Firebase Genkit
  • Sweep
  • Devin
  • Phind
  • Mentat
  • Claude Desktop
  • Aider
  • GPT Pilot
  • Plandex
  • bolt.new
  • v0
  • Replit Agent
  • Anse
  • TypingMind
  • BetterChatGPT
  • LibreChat
  • Warp AI
  • Pieces
  • Fig AI
Embed badge
vskill VERIFIED badge
[![vskill VERIFIED](https://verified-skill.com/api/v1/skills/sqhh99/point/project-records/badge)](https://verified-skill.com/skills/sqhh99/point/project-records)

Something wrong with this skill or its page? Tell us.