agent-rules贡献指南：如何创建高质量的可重用规则

【免费下载链接】agent-rules Rules and Knowledge to work better with agents such as Claude Code or Cursor 项目地址: https://gitcode.com/gh_mirrors/ag/agent-rules

欢迎来到agent-rules项目的贡献指南！🎉 这是一个专为AI助手（如Claude Code或Cursor）设计的规则知识库，旨在帮助开发者更高效地使用智能编程工具。本文将为你详细介绍如何创建高质量的可重用规则，让你的贡献能够被更多开发者使用和受益。

📚 什么是agent-rules？

agent-rules是一个开源知识库，包含了与AI助手协作的最佳实践和规则模板。项目分为三个主要部分：

• 全局规则 (global-rules/) - 适用于所有项目的通用规则
• 项目规则 (project-rules/) - 针对特定项目类型的专用规则
• 文档 (docs/) - 技术文档和最佳实践指南

🛠️ 创建高质量规则的步骤

1. 理解规则结构

每个规则文件都遵循特定的格式，包含清晰的指令、示例和最佳实践。高质量规则应该：

• 具有明确的适用范围和目的
• 提供具体的操作步骤
• 包含实用的代码示例
• 考虑不同的使用场景

2. 编写清晰易懂的内容

你的规则应该能够被新手开发者轻松理解：

• 使用简单的语言和术语
• 提供循序渐进的指导
• 包含常见问题的解决方案
• 使用emoji和格式化提高可读性

3. 测试和完善

在提交规则前，务必进行充分测试：

• 验证规则的准确性和有效性
• 确保示例代码能够正常运行
• 检查文档的完整性和一致性

4. 遵循命名规范

规则文件的命名应该：

• 使用连字符分隔单词
• 明确反映规则的功能
• 保持简洁和直观

🎯 最佳实践建议

创建可重用规则时，请考虑以下要点：

• 模块化设计 - 将复杂任务分解为小的、可重用的组件
• 错误处理 - 包含常见的错误场景和解决方案
• 性能优化 - 提供效率优化的建议
• 兼容性 - 考虑不同环境和工具的兼容性

🤝 提交贡献

准备好提交你的规则时：

1. 确保规则文件位于正确的目录
2. 提供清晰的描述和用法说明
3. 包含必要的测试用例
4. 遵循项目的代码风格指南

通过遵循这些指导原则，你将能够创建出真正有价值、可重用的规则，帮助整个开发者社区更好地利用AI编程助手的力量！✨

记住，好的规则就像好的工具 - 它们应该让复杂的事情变得简单，让重复的工作变得高效。现在就开始你的贡献之旅吧！

【免费下载链接】agent-rules Rules and Knowledge to work better with agents such as Claude Code or Cursor 项目地址: https://gitcode.com/gh_mirrors/ag/agent-rules