Welcome to AWS Docs! We thrive on your contribution. ❤️
Please take a moment to familiarize yourself with the following:
We use GitHub Issues to organize all significant work, meaning any external contributions will first take the form of issues.
Briefly review all open issues for two (2) reasons:
- Search for contribution opportunities
- Verify that your contribution idea is not already in progress
To create a new issue, use the following two (2) templates:
All non-bugfix contributions must be pre-approved by the maintainers.
At any time, you may close issues that you create yourself.
Follow these steps when you are ready to begin writing code:
- Fork the repository.
- Modify your fork using the CLI or GitHub flow
- When your fork contains your finished and tested code, create a pull request.
For single-line bugfixes, you may optionally edit the file directly on the Github website without the need to create a fork.
- Follow coding best practices such as DRY and SOLID where possible.
- Carefully read the pull request template and follow it closely.
- Don't include AWS account identifiers or secret keys in your examples.
Review the following important disclaimers before contributing to this project.
This project abides by the Amazon Open Source Code of Conduct. For additional help, contact [email protected].
If you discover a potential security issue, please notify AWS Security via our vulnerability reporting page. Please do not create a public issue on GitHub.
See the LICENSE file for this project's licensing. We will ask you to confirm the licensing of your contribution. We may ask you to sign a Contributor License Agreement (CLA) for larger changes.
To request help or clarification on this CONTRIBUTING.md, simply add a comment in your issue and we will reply within 5 business days.