CDK Contribution Skill: A Guide to Standardized Workflow for AWS CDK Contributions

CDK Contribution Skill is a set of standardized workflow guidelines for contributors to the AWS CDK project. It aims to help developers streamline the entire process from problem analysis to PR submission, reducing back-and-forth communication costs through structured phase division, review checkpoints, and reference documents. This guide does not replace the contributor's judgment; instead, it provides clear path guidance so that each step has a basis to follow.

Project Background

AWS Cloud Development Kit (CDK) is an infrastructure-as-code framework launched by Amazon Web Services, allowing developers to define cloud resources using familiar programming languages. As the CDK ecosystem grows, community contributions become increasingly important, but the complex contribution process often discourages newcomers.

Core Objectives

• Provide clear path guidance for CDK contribution tasks
• Reduce back-and-forth communication costs through phased processes
• Establish repeatable review checkpoints
• Provide standardized reference documents and prompt templates
• Cover the entire process from issue review to PR submission

The project emphasizes: it does not replace the contributor's judgment, only helps follow established processes.

Core Design Philosophy

1. Structured Workflow: Decompose into clear phases, each containing input/output, execution steps, review checkpoints, and deliverables.
2. Repeatability: Ensure different contributors follow the same standards through standardized prompt templates, with clear evaluation criteria for reviews.
3. Progressive Advancement: Gradually advance from problem understanding → planning and design → implementation self-review → PR preparation.

Detailed Workflow Phases

1. Issue Review: Analyze the issue, understand the background, identify relevant modules, evaluate scope, and produce an issue analysis report.
2. Task Planning: Develop a solution outline, identify modified files, evaluate complexity, plan testing and documentation updates, and produce an implementation plan.
3. Change Drafting: Implement code changes, write tests, update documentation, comply with code standards, and produce a code change set.
4. Self-Review: Check code logic, test coverage, documentation completeness, and compliance with contribution agreements, and produce a review checklist.
5. PR Preparation: Write a clear PR description, link the issue, provide test evidence, and produce a complete PR.

Project Structure

• Core Files: skill/SKILL.md (main guide, guiding the entire process); skill/references/ (stores reference materials such as issue analysis templates, code style guides, PR description templates, etc.).
• Prompt Template System: Repeatable guidance for contribution processes, compatible with Kiro IDE, also supports manual following.

Usage Methods

1. Basic Process: Download the project → Read SKILL.md → Follow phase guidance to execute → Refer to references files → Submit PR.
2. Kiro IDE Integration: Open the skill file, execute step by step according to prompts, and use IDE functions to assist editing.
3. Manual Use: Read the files and follow the steps, using templates and checklists.

System Requirements

• Basic: Windows 10/11, browser, text editor.
• Full Contribution: GitHub account, Git, AWS CDK environment, programming language environment (TypeScript/Python/Java/.NET).
• Recommended Tools: GitHub Desktop, VS Code, File Explorer, Notepad.

Project Value

• Contributors: Lower entry barriers (clear paths, templates), improve contribution quality (systematic checkpoints), increase efficiency (reduce communication).
• Maintainers: Simplify review processes (unified format), improve community health (reduce loss of new contributors).
• Project: Sustainable development (knowledge inheritance, reduce reliance on core maintainers).

Best Practice Recommendations

• Usage Tips: Keep the GitHub page open, read one file at a time, do not skip checkpoints, return to SKILL.md when lost, save progress frequently.
• Avoid Pitfalls: Do not rush into coding, fully understand the problem before planning, be strict in self-review, ensure PR descriptions are clear and complete.

Scenario 1: Fixing a CDK Bug

Background: Discover abnormal behavior of a CDK construct → Find the relevant issue → Analyze the problem according to SKILL.md → Plan the fix → Implement changes and tests → Self-review → Submit a PR linking the issue.

Scenario 2: Adding a New Feature

Background: Need to support a new AWS service → Research service documentation → Define requirements using Skill → Plan API design → Implement constructs and tests → Verify API consistency → Submit a PR with design instructions.

Scenario 3: Document Improvement

Background: Discover document errors/missing content → Locate the problem → Plan improvement scope → Write document updates → Self-review for accuracy → Submit a document PR.

CDK Contribution Skill's future development directions include:

• Support contribution processes for more AWS projects;
• Integrate automated tools to verify review checkpoints;
• Establish a contribution case library;
• Multilingual support;
• Supporting video tutorials.

This guide provides a structured methodology for AWS CDK and open-source project contributors, decomposing complex processes into manageable steps to help them participate professionally in open-source community building.