A collection of versioned project rules to enhance CDK application development with Amazon Q Developer.
We need your expertise! This project is actively seeking contributions from AWS Community members. While this is only a start to establish a foundation of CDK best practices, we recognize that the collective wisdom of the community will make these rules more robust, comprehensive, and valuable. Whether you have insights on specific AWS services, architectural patterns, security considerations, or performance optimizations - your experience can help shape these guidelines and benefit the entire CDK developer community.
This repository provides a set of standardized project rules that can be used with Amazon Q Developer to improve the development experience when working with AWS Cloud Development Kit (CDK). These rules help developers follow best practices, maintain consistency, and accelerate development of CDK applications.
Amazon Q Developer can leverage these project rules to:
- Generate more consistent and high-quality CDK code
- Follow established best practices for CDK development
- Implement secure-by-default infrastructure as code
- Accelerate development workflows
- Reduce common errors and anti-patterns
This repository is organized into several rule categories:
- CDK Project Structure - Guidelines for organizing CDK projects
- CDK TypeScript - TypeScript-specific best practices for CDK
- CDK Design Patterns - Recommended design patterns for CDK applications
- CDK Security & Compliance - Security best practices for CDK
- CDK Constructs - Guidelines for creating and using CDK constructs
- CDK Testing - Best practices for testing CDK applications
These project rules can be applied to various CDK development scenarios:
- Starting new CDK projects with best practices baked in
- Refactoring existing CDK code to follow best practices
- Ensuring consistency across multiple CDK projects in an organization
- Training new developers on CDK best practices
We welcome contributions from the AWS Community! Please see our Contributing Guidelines for details on how to submit improvements.
This project is licensed under the MIT License.