Project Rules
Create RuleDiscover and explore Amazon Q project rules created by the community to enforce coding standards and best practices
Project Intelligence
The project intelligence documentation system transforms Amazon Q Developer from a stateless assistant into a persistent development partner by providing comprehensive context about your application across various sessions. Once the rule was added to your repository, you can ask Q Developer to initialize the project intelligence with "Initialize Project Intelligence". If already in place, you can force an update by asking Q "Update Project Intelligence".
Python Programming Rules
Some rules defining strict ways of working, encouraging specifications to be completed, and a detailed development plan including AI prompts. The main components are enforcing a TDD approach where tests are written first and any test failures means we need to focus on the code (not change the tests).
Markdown Best Practices
I have noticed that the Claude model sometimes creates markdown files with linting issues, which prompted me to create these rules, extracted from the markdown-lint code on GitHub.
Typescript TDD Behavioural Test Specifications
Encourages a Test-Driven Design approach, with behaviour-like descriptions. The output of the test run should resemble a specification. Tests will be co-located with the actual code files and follow the *.spec.ts naming convention. The final rule is "Definition of Done", which prompts the AI assistant to ensure that the code is in a good state with all tests passing and no errors or warnings. Note: Linting examples assume `npm lint:fix` script exists.
Keep code in sync with drawio diagram
Generate code from drawio diagram and keep code in sync with the diagram (works with q CLI) Create a drawio diagram in vscode, start 'q chat' and simply type the same prompt all the time: > generate application
CDK Design Patterns
Outlines recommended design patterns for AWS CDK development. Design patterns are reusable solutions to common problems in software development. Following these patterns will ensure consistency, maintainability, and scalability across the codebase. The patterns described here are particularly relevant for AWS CDK development.
CDK Security and Compliance
Outlines security and compliance best practices for AWS CDK applications. Security is a critical aspect of infrastructure as code, and following these guidelines will help ensure that your CDK applications are secure, compliant, and follow AWS best practices.
CDK Construct Development
Outlines best practices for developing AWS CDK constructs. Following these guidelines will ensure that constructs are reusable, maintainable, and follow AWS best practices.
CDK Testing
Outlines best practices for testing AWS CDK applications. Testing is a critical aspect of CDK development to ensure that infrastructure is deployed correctly and behaves as expected. Following these guidelines will help create reliable, maintainable, and well-tested infrastructure code.
CDK Project Structure
This document outlines the recommended project structure for AWS CDK applications. A well-organized project structure is critical for maintainability, scalability, and developer onboarding. Following these guidelines will ensure consistency across the codebase and make navigation easier as the project grows.
CDK Typescript Best Practices
TypeScript best practices for AWS CDK development. Following these guidelines will ensure type safety, code consistency, and maintainability across the codebase. TypeScript's static typing capabilities help catch errors early in the development process and provide better tooling support.
Amplify Data Modeling
Project rules to tune Amazon Q Developer in all things related to data modeling and modeling relationships with AWS Amplify Gen2
Next.js rules for promptz.dev
Next.js rules used to build promptz.dev
Amplify Authentication
Project rules to steer Amazon Q Developer for all things related to implementing authentication with AWS Amplify Gen2