Postgres Best Practices 说明文档

# Postgres 最佳实践 - 贡献者指南 本仓库包含为 AI 智能体和 LLM 优化的 Postgres 性能优化规则。 ## 快速开始 bash # 安装依赖 cd packages/postgres-best-practices-build npm install # 验证现有规则 npm run validate # 构建 AGENTS.md npm run build ## 创建新规则 1. **根据类别选择部分前缀**： - `query-` 查询性能 (关键) - `conn-` 连接管理 (关键) - `security-` 安全与 RLS (关键) - `schema-` 模式设计 (高) - `lock-` 并发与锁定 (中高) - `data-` 数据访问模式 (中) - `monitor-` 监控与诊断 (低中) - `advanced-` 高级功能 (低) 2. **复制模板**： bash cp rules/_template.md rules/query-your-rule-name.md 3. **按照模板结构填充内容** 4. **验证并构建**： bash npm run validate npm run build 5. **审查** 生成的 `AGENTS.md` ## 仓库结构 skills/postgres-best-practices/ ├── SKILL.md # 面向智能体的技能清单 ├── AGENTS.md # [已生成] 编译后的规则文档 ├── README.md # 本文件 ├── metadata.json # 版本和元数据 └── rules/ ├── _template.md # 规则模板 ├── _sections.md # 部分定义 ├── _contributing.md # 编写指南 └── *.md # 单个规则 packages/postgres-best-practices-build/ ├── src/ # 构建系统源码 ├── package.json # NPM 脚本 └── test-cases.json # [已生成] 测试产物 ## 规则文件结构 请参阅 `rules/_template.md` 获取完整模板。关键要素： `markdown --- title: 清晰、以行动为导向的标题 impact: CRITICAL|HIGH|MEDIUM-HIGH|MEDIUM|LOW-MEDIUM|LOW impactDescription: 量化收益 (例如: "10-100 倍提升") tags: 相关关键词 --- ## [标题] [1-2 句解释] **错误 (描述):** sql -- 注释解释错误之处 [错误的 SQL 示例] ` **正确 (描述):** sql -- 注释解释为何这样更好 [正确的 SQL 示例] ## 编写指南 请参阅 `rules/_contributing.md` 获取详细指南。核心原则： 1. **展示具体转换** - “将 X 改为 Y”，而非抽象建议 2. **错误优先结构** - 在给出解决方案前先展示问题 3. **量化影响** - 包含具体指标