CDK Contribution Skill：AWS CDK 贡献标准化工作流指南

CDK Contribution Skill 是一套面向 AWS CDK 项目贡献者的标准化工作流指南，旨在通过结构化的阶段划分、审查检查点和参考文档，帮助开发者从问题分析到提交 PR 的整个过程更加高效规范，减少来回沟通成本。该指南不替代贡献者的判断，而是提供清晰的路径指引，使每个步骤有据可依。

项目背景

AWS Cloud Development Kit（CDK）是亚马逊云科技推出的基础设施即代码框架，允许开发者使用熟悉的编程语言定义云资源。随着 CDK 生态壮大，社区贡献愈发重要，但复杂的贡献流程常让新手却步。

核心目标

• 为 CDK 贡献任务提供清晰路径指引
• 通过分阶段流程减少来回沟通成本
• 建立可重复的审查检查点
• 提供标准化参考文档和提示模板
• 覆盖从问题审查到 PR 提交的全过程

该项目强调：不替代贡献者判断，仅帮助遵循既定流程。

核心设计理念

1. 结构化工作流：分解为明确阶段，每个阶段含输入输出、执行步骤、审查检查点和可交付成果。
2. 可重复性：通过标准化提示模板确保不同贡献者遵循相同标准，审查有明确评估依据。
3. 渐进式推进：从问题理解→规划设计→实现自审→PR准备逐步推进。

工作流阶段详解

1. 问题审查：分析 Issue、理解背景、识别相关模块、评估范围，产出问题分析报告。
2. 任务规划：制定解决方案大纲、识别修改文件、评估复杂度、规划测试与文档更新，产出实施计划。
3. 变更起草：实施代码变更、编写测试、更新文档、符合代码规范，产出代码变更集。
4. 自我审查：代码逻辑、测试覆盖率、文档完整性、贡献协议合规性检查，产出审查清单。
5. PR准备：编写清晰 PR 描述、关联 Issue、提供测试证据，产出完整 PR。

项目结构

• 核心文件：skill/SKILL.md（主指南，指导全流程）；skill/references/（存储问题分析模板、代码风格指南、PR描述模板等参考资料）。
• 提示模板系统：可重复引导贡献流程，兼容 Kiro IDE，也支持手动遵循。

使用方式

1. 基础流程：下载项目→阅读 SKILL.md→跟随阶段指引执行→参考 references 文件→提交 PR。
2. Kiro IDE 集成：打开 skill 文件，按提示逐步执行，利用 IDE 功能辅助编辑。
3. 手动使用：阅读文件并遵循步骤，使用模板和检查清单。

系统要求

• 基础：Windows 10/11、浏览器、文本编辑器。
• 完整贡献：GitHub 账户、Git、AWS CDK 环境、编程语言环境（TypeScript/Python/Java/.NET）。
• 推荐工具：GitHub Desktop、VS Code、File Explorer、Notepad。

项目价值

• 贡献者：降低入门门槛（清晰路径、模板）、提升贡献质量（系统化检查点）、提高效率（减少沟通）。
• 维护者：简化审查流程（统一格式）、提升社区健康度（减少新贡献者流失）。
• 项目：可持续发展（知识传承、减少核心维护者依赖）。

最佳实践建议

• 使用技巧：保持 GitHub 页面打开、一次读一个文件、不跳过检查点、迷路时返回 SKILL.md、经常保存进度。
• 避免陷阱：不急于编码、充分理解问题再规划、自我审查严格、PR描述清晰完整。

场景一：修复 CDK Bug

背景：发现 CDK 构造行为异常→找到相关 Issue→按 SKILL.md 分析问题→规划修复方案→实施变更与测试→自我审查→提交 PR 关联 Issue。

场景二：添加新功能

背景：需支持新 AWS 服务→研究服务文档→用 Skill 定义需求→规划 API 设计→实现构造与测试→验证 API 一致性→提交 PR 附设计说明。

场景三：文档改进

背景：发现文档错误/缺失→定位问题→规划改进范围→编写文档更新→自我审查准确性→提交文档 PR。

CDK Contribution Skill 的未来发展方向包括：

• 支持更多 AWS 项目的贡献流程；
• 集成自动化工具验证审查检查点；
• 建立贡献案例库；
• 多语言支持；
• 配套视频教程。

该指南为 AWS CDK 及开源项目贡献者提供了结构化方法论，将复杂流程分解为可管理步骤，助力专业参与开源社区建设。