rios0rios0/guide
GitHub: rios0rios0/guide
一套覆盖软件开发全生命周期的工程规范指南,能够自动为主流 AI 编码助手生成规则文件,帮助团队在 AI 辅助开发中统一代码标准。
Stars: 2 | Forks: 5
Guide
这是一份全面的软件开发指南,涵盖了敏捷文化、架构、代码风格、测试、CI/CD 以及团队入职等内容。其目的不是将开发限制在特定形式上,而是提供一个共同的基础,以便更好地发挥协同作用,并从过往的上下文中汲取经验。 ## 概述 - [主页](Home.md) - [入职](Onboarding.md) - [敏捷与文化](Agile-&-Culture.md) - [PDCA](Agile-&-Culture/PDCA.md) - [生命周期](Life-Cycle.md) - [Git Flow](Life-Cycle/Git-Flow.md) - [合并指南](Life-Cycle/Git-Flow/Merge-Guide.md) - [架构](Life-Cycle/Architecture.md) - [后端](Life-Cycle/Architecture/Backend-Design.md) - [前端](Life-Cycle/Architecture/Frontend-Design.md) - [测试](Life-Cycle/Tests.md) - [CI & CD](Life-Cycle/CI-&-CD.md) - [安全](Life-Cycle/Security.md) - [文档与变更控制](Life-Cycle/Documentation-&-Change-Control.md) - [README 模板](Life-Cycle/Documentation-&-Change-Control/README-Template.md) - [CONTRIBUTING 模板](Life-Cycle/Documentation-&-Change-Control/CONTRIBUTING-Template.md) - [CHANGELOG 格式](Life-Cycle/Documentation-&-Change-Control/CHANGELOG-Formatting.md) - [代码风格](Code-Style.md) - [语言指南模板](Code-Style/Language-Guide-Template.md) - [GoLang](Code-Style/GoLang.md) - [规范](Code-Style/GoLang/GoLang-Conventions.md) - [格式化与 Lint](Code-Style/GoLang/GoLang-Formatting-and-Linting.md) - [类型系统](Code-Style/GoLang/GoLang-Type-System.md) - [日志](Code-Style/GoLang/GoLang-Logging.md) - [测试](Code-Style/GoLang/GoLang-Testing.md) - [项目结构](Code-Style/GoLang/GoLang-Project-Structure.md) - [JavaScript](Code-Style/JavaScript.md) - [JavaScript 测试](Code-Style/JavaScript/JavaScript-Testing.md) - [YAML](Code-Style/YAML.md) - [Java](Code-Style/Java.md) - [规范](Code-Style/Java/Java-Conventions.md) - [格式化与 Lint](Code-Style/Java/Java-Formatting-and-Linting.md) - [类型系统](Code-Style/Java/Java-Type-System.md) - [日志](Code-Style/Java/Java-Logging.md) - [测试](Code-Style/Java/Java-Testing.md) - [项目结构](Code-Style/Java/Java-Project-Structure.md) - [Python](Code-Style/Python.md) - [规范](Code-Style/Python/Python-Conventions.md) - [格式化与 Lint](Code-Style/Python/Python-Formatting-and-Linting.md) - [类型系统](Code-Style/Python/Python-Type-System.md) - [日志](Code-Style/Python/Python-Logging.md) - [测试](Code-Style/Python/Python-Testing.md) - [项目结构](Code-Style/Python/Python-Project-Structure.md) - [实用手册](Cookbooks.md) - [工具与设置](Cookbooks/Tools-&-Setup.md) - [WSL 设置](Cookbooks/Tools-&-Setup/WSL-Setup.md) - [安装 Azure CLI](Cookbooks/Tools-&-Setup/Install-Azure-CLI.md) - [Azure Functions 设置](Cookbooks/Tools-&-Setup/Azure-Functions-Setup.md) - [数据库同步](Cookbooks/Tools-&-Setup/Database-Sync.md) - [Fork 技术](Cookbooks/Forking-Technique.md) - [历史仓库清理](Cookbooks/Historical-Repository-Cleaner.md) - [Mapper 设计模式](Cookbooks/Mapper-Design-Pattern.md) - [批量操作](Cookbooks/Bulk-Operations.md) - [AI 辅助工作流](Cookbooks/AI-Assisted-Workflows.md) ## AI 助手规则 本仓库会根据文档自动为 AI 编码助手(Claude Code、Cursor、Codex、GitHub Copilot)生成规则文件。它还会从外部仓库获取精选的 agent。生成的文件位于 [`generated`](https://github.com/rios0rios0/guide/tree/generated) 分支,可以通过以下方式安装: ``` curl -fsSL https://raw.githubusercontent.com/rios0rios0/guide/generated/install-rules.sh | sh ``` 或者下载 `install-rules.sh` 并使用 `--force` 参数运行以进行非交互式安装。详情请参见 [install-rules.sh](install-rules.sh)。 ## 参考 - [Vizir 的风格指南](https://github.com/Vizir/styleguide) - [优秀的开源替代品](https://github.com/VolhaBakanouskaya/awesome-oss-alternatives-public) ## 贡献 欢迎踊跃贡献。有关指南,请参见 [CONTRIBUTING.md](CONTRIBUTING.md)。 ## 许可证 本项目遵循 [LICENSE](LICENSE) 文件中规定的条款进行授权。标签:AI编程助手, Claude Code, Codex, Cursor, Cutter, DevSecOps, GitHub Copilot, JS文件枚举, 上游代理, 代码安全, 代码质量控制, 代码风格, 团队规范, 开发者指南, 敏捷开发, 数据可视化, 数据管道, 日志审计, 架构设计, 测试, 漏洞枚举, 编码规范, 软件工程, 逆向工具, 项目说明文档