SuperAPI AI 工具集

maintain-greptile-rules

编程与开发

查看项目

更新于 10-18 16:15

技能介绍

版本与核实范围

本页恢复所列2026-09-19固定提交的完整主指南,并提供全文中文翻译。2026-10-19核对完整提交、Git树、文件blob、原文、译文及MIT许可;源文件的internal:true标记和全部原始元数据保留,不据此声称它是可独立安装的公开产品。目录名称、来源和安装命令保持原值,当前安装对应关系和运行效果未实测。来源页本次返回410,未重试;正文由独立验证的历史发布者Git文件取得。所引用的Greptile配置、其他技能和配套文件未另行恢复,源文中的命令、规则修改、审查与组织配置指令均未执行。

发布者固定提交原文

完整主指南

维护 Greptile 规则

保持 .greptile/ 的规则有效、少误报。审查发现是需要评估的证据,而不是自动成为新规则。

1. 验证发现

  • 对照当前仓库复现或追踪该发现,包括相关调用路径、测试和有意设置的例外。
  • 在提出变更之前,阅读 .greptile/config.json、.greptile/rules.md 和 .greptile/files.json。
  • 区分新引入的风险与相邻的遗留债务。不要将未经证实的假设或一次性的实现细节固化为规则。
  • 仓库中不存在某做法并不构成策略证据。如果审查者仅因当前没有示例而推断出某种偏好,则保持 Greptile、代码和 CI 不变,除非所有者明确采纳该策略。

2. 将其路由到正确的机制

  • 一次性缺陷: 修复代码并添加针对性的回归测试。不要添加 Greptile 规则。
  • 经验证的确定性策略违规: 优先使用 TypeScript、Oxlint、Knip、针对性测试或 CI。
  • 可重复、可在 diff 中强制执行的不变量: 在 .greptile/config.json 中添加或改进限定范围的结构化规则。
  • 架构、偏好或误报校准: 更新 .greptile/rules.md。
  • Greptile 应参考的规范实现: 在 .greptile/files.json 中添加范围狭窄的引用。
  • 工作流中的小障碍: 使用 papercuts 技能并将其记录在 .agents/PAPERCUTS.md 中。

3. 应用升级标准

仅当所有适用检查均通过时,才将发现升级为规则:

  • 已对照当前代码验证。
  • 未来的审查者可以从 diff 和相关调用路径中观察到它。
  • 它具有仓库特定性,或能实质性改善误报校准。
  • 它很可能再次出现,或其影响足够高以证明预防的合理性:授权、安全、计费、数据丢失或跨数据库正确性。
  • 现有 Greptile 上下文和自动化检查尚未充分覆盖它。
  • 该指令可以具体、可衡量、范围狭窄,并明确说明合理的例外。

如果证据或策略不明确,则保持配置和强制执行不变,并将候选方案报告给人工判断。

4. 保守地编辑

  • 每条结构化规则保持一个连贯的关注点,具有稳定的小写 ID、严重级别和能够覆盖后续同类问题的最小范围。
  • 不要仅仅因为当前仓库对某种替代方案零示例就推断出永久策略。
  • 优先收窄或替换误报较多的规则,而不是叠加更多文字说明。
  • 将仓库特定规则保存在 .greptile/ 中。验证并报告一个由组织强制执行的最小仪表板基线配置是否保护外部贡献、机密信息、身份验证、计费、CI 以及试图削弱审查控制的尝试。除非用户明确要求,否则不要创建或更改仪表板、MCP 或组织规则,也不要在那里复制完整的仓库规则集。
  • 将对 .greptile/**、AGENTS.md、CLAUDE.md、.agents/skills/** 和 .github/** 的更改视为审查控制变更,必须获得维护者的明确审查。CODEOWNERS 请求该审查;分支保护或规则集必须在可用时单独要求代码所有者批准。
  • 更新所需的最小配置文件集;不要在单独的文档中重复规则正文。

5. 验证

运行:

jq empty .greptile/config.json .greptile/files.json
node_modules/.bin/prettier --check .greptile/config.json .greptile/files.json .greptile/rules.md
git diff --check

同时验证规则 ID 唯一、严重级别有效、每个 files.json 路径都存在,并且独立审查者无法在新措辞中发现明显的误报。

在合并就绪的工作中,仅评估通过升级标准的经验证发现。当未发现持久的审查缺口时,合并就绪的运行不需要更改 .greptile/。

原始元数据

name: maintain-greptile-rules
description: Evaluate verified findings from merge-ready, Greptile, pull-request, CI, security, billing, and other code reviews, then promote durable review gaps into the version-controlled .greptile configuration. Use when a review uncovers a recurring or high-risk repository invariant that Greptile does not capture, when Greptile repeatedly produces a false positive, or when asked to audit or update OpenSEO's Greptile rules and context.
metadata:
  internal: true

原作者与许可

MIT License

Copyright (c) 2026 Ben Senescu

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.