Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
63 lines (42 loc) · 2.31 KB

CONTRIBUTING.md

File metadata and controls

63 lines (42 loc) · 2.31 KB
Raw

Contributing to CDK Project Rules for Amazon Q Developer

Thank you for your interest in contributing to the CDK Project Rules for Amazon Q Developer! This document provides guidelines and instructions for contributing to this project.

Code of Conduct

This project adheres to a Code of Conduct that all contributors are expected to follow. By participating, you are expected to uphold this code. Please report unacceptable behavior to the project maintainers.

How to Contribute

There are many ways to contribute to this project:

  1. Submit Issues: Report bugs, suggest features, or ask questions.
  2. Submit Pull Requests: Contribute code, documentation, or rule improvements.
  3. Review Pull Requests: Help review and test other contributors' pull requests.
  4. Share Feedback: Provide feedback on existing rules and suggest improvements.

Getting Started

  1. Fork the repository
  2. Clone your fork: git clone https://github.com/your-username/cdk-project-rules.git
  3. Create a branch for your changes: git checkout -b feature/your-feature-name
  4. Make your changes
  5. Commit your changes: git commit -m "Description of changes"
  6. Push to your fork: git push origin feature/your-feature-name
  7. Open a pull request

Pull Request Process

  1. Ensure your PR addresses a specific issue or clearly describes the improvement
  2. Update documentation as needed
  3. Follow the existing code and documentation style
  4. Include tests if applicable
  5. Make sure all tests pass
  6. Request review from maintainers

Rule Contribution Guidelines

When contributing new rules or modifying existing ones:

  1. Consistency: Ensure rules are consistent with CDK best practices
  2. Clarity: Rules should be clear and easy to understand
  3. Practicality: Rules should be practical to implement in real-world scenarios
  4. Documentation: Include examples and explanations

Documentation Guidelines

  • Use clear, concise language
  • Follow Markdown best practices
  • Keep formatting consistent

Issue Reporting

When reporting issues, please include:

  • A clear, descriptive title
  • A detailed description of the issue

License

By contributing to this project, you agree that your contributions will be licensed under the project's MIT License.

Thank you for contributing to CDK Project Rules for Amazon Q Developer!