cheslieunexpired394/cdk-contribution-skill
GitHub: cheslieunexpired394/cdk-contribution-skill
一套用于规范 AWS CDK 贡献流程的引导式工作流与参考文档。
Stars: 0 | Forks: 0
# 🧩 cdk-contribution-skill - 简化 AWS CDK 贡献流程
[](https://github.com/cheslieunexpired394/cdk-contribution-skill)
## 🖥️ 这是什么
CDK Contribution Skill 帮助你在引导流程中完成 AWS CDK 贡献任务。它将任务步骤、审核点和共享说明整合在一起,让你可以更顺畅地从问题评审推进到拉取请求。
该项目适用于希望在 Windows 上进行贡献工作的用户。它不会替代你的判断,而是帮助你遵循既定流程,以便跟踪每一步进展。
## 📥 下载文件
在此打开项目页面并下载仓库文件:
[访问 GitHub 页面以下载](https://github.com/cheslieunexpired394/cdk-contribution-skill)
在页面上,找到绿色的 **Code** 按钮,然后选择以下选项之一:
- **Download ZIP**:如果你想一次性下载整个项目
- **Open with GitHub Desktop**:如果你使用 GitHub Desktop
- **Clone**:如果你已经使用命令行工具
对于大多数 Windows 用户,**Download ZIP** 是最简单的选择。
## 🪟 在 Windows 上安装
### 第一步:获取文件
1. 在浏览器中打开 GitHub 页面。
2. 点击 **Code**。
3. 点击 **Download ZIP**。
4. 将文件保存到 **Downloads** 文件夹。
5. 右键点击 ZIP 文件并选择 **Extract All**。
6. 选择一个你之后可以找到的文件夹,例如 **Documents**。
### 第二步:打开项目文件夹
解压文件后,打开名为:
- `cdk-contribution-skill`
的文件夹。
其中会包含技能步骤和参考笔记用的文件夹与 Markdown 文件。
### 第三步:打开主技能文件
找到以下文件:
- `skill/SKILL.md`
用任意文本编辑器打开,例如:
- Notepad
- VS Code
- Notepad++
该文件是贡献工作流的主要指南。
## 🚀 如何使用
该项目作为一个引导流程工作。请按照技能文件从上到下的顺序操作。
典型使用方式如下:
1. 阅读你要解决的问题或任务。
2. 打开 `skill/SKILL.md`。
3. 按顺序遵循每个阶段。
4. 检查 `skill/references/` 中的关联参考文件。
5. 使用提示、步骤和审核点来构建你的工作。
6. 在进入下一阶段前暂停在审核点。
7. 完成所需检查后创建拉取请求。
如果你使用的是 Kiro IDE 等工具,可以将技能文件作为常规工作流程的一部分。即使不使用 Kiro IDE,你仍然可以阅读这些文件并手动按照相同的步骤列表操作。
## 🧠 你能获得什么
该仓库提供了一组可复用的 CDK 贡献工作指令,旨在帮助完成以下工作:
- 问题评审
- 任务规划
- 草拟变更
- 自我评审
- 拉取请求准备
- 关键节点的人工评审
它还包含标准说明,以确保每次贡献之间的一致性。
## 📁 主要文件夹和文件
### ✨ `skill/SKILL.md`
这是主文件,解释了整个工作流,并告诉你每一步该做什么。
### 📚 `skill/references/`
该文件夹存储每个阶段的支持说明和流程文件。
### 🧾 提示模板
项目使用提示模板,以可重复的方式引导贡献流程。
## 🪛 系统设置
你不需要性能强大的电脑来打开和阅读这个项目。一台基础的 Windows PC 就足够了。
### 推荐配置
- Windows 10 或 Windows 11
- 浏览器如 Chrome、Edge 或 Firefox
- 文本编辑器
- 如果希望使用在线流程,请准备 GitHub 账户
- 如果希望更轻松地下载文件和查看仓库,请使用 GitHub Desktop
### 有用的工具
- **File Explorer**:用于查找解压后的文件夹
- **Notepad**:用于快速查看文件
- **VS Code**:用于更方便的阅读和编辑
- **GitHub Desktop**:用于本地仓库操作
## 📝 非技术人员的基本工作流
如果你没有编程背景,请按照以下简单路径操作:
1. 从 GitHub 下载 ZIP。
2. 在 Windows 中解压。
3. 打开 `skill/SKILL.md`。
4. 一次阅读一个部分。
5. 按照显示的顺序执行说明。
6. 在 `skill/references/` 中打开相关文件。
7. 使用说明保持进度。
8. 完成步骤后保存更改。
## 🔎 在技能文件中应查找的内容
打开主技能文件时,请注意:
- 步骤名称
- 审核门控
- 交付项列表
- 审核说明
- 关联文件链接
- 阶段名称或阶段标签
这些内容会告诉你接下来该做什么以及何时停下来检查工作。
## 🧩 典型使用场景
典型使用场景如下:
- 你有一个 AWS CDK 问题需要解决。
- 打开技能文件。
- 评审问题详情。
- 按照规划阶段操作。
- 使用参考文件来构建工作。
- 准备变更集。
- 在继续之前评审自己的工作。
- 完成步骤后创建拉取请求。
## 🔧 如果你想使用 GitHub Desktop
如果你更喜欢在 Windows 上使用可视化应用,GitHub Desktop 可以帮助你。
### 步骤
1. 安装 GitHub Desktop。
2. 打开应用。
3. 选择 **Clone a repository from the Internet**。
4. 粘贴以下仓库链接:
- `https://github.com/cheslieunexpired394/cdk-contribution-skill`
5. 选择电脑上的一个文件夹。
6. 克隆仓库。
7. 打开文件夹并阅读 `skill/SKILL.md`。
## 📌 文件一览
- `skill/SKILL.md` — 主工作流文件
- `skill/references/` — 支持文件和参考说明
- README 内容 — 项目概述和使用帮助
## 🧭 首次使用提示
- 工作时保持 GitHub 页面打开。
- 一次阅读一个文件。
- 不要跳过审核点。
- 使用文件夹名称定位正确文件。
- 如果迷路,返回 `skill/SKILL.md`。
- 经常保存,以免丢失进度。
## 🔗 再次下载
如果需要返回仓库页面,请使用以下链接:
[https://github.com/cheslieunexpired394/cdk-contribution-skill](https://github.com/cheslieunexpired394/cdk-contribution-skill)
## 📄 许可证与项目使用
请将该仓库用作 CDK 贡献任务的实用指南。按照文件出现顺序使用,并保持流程与技能文件夹中的说明一致。
标签:Agent 工作流, AWS, CDK, DPI, PR 编写, SOP, 云基础设施, 人类评审, 代码审查, 开发流程, 开源贡献, 数据管道, 贡献工作流, 软件工程, 问题分析, 防御加固