Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
84 lines (62 loc) · 4.21 KB

CONTRIBUTING.md

File metadata and controls

84 lines (62 loc) · 4.21 KB

Contributing guidelines

Welcome to AWS Docs! We thrive on your contribution. ❤️

Get started

Please take a moment to familiarize yourself with the following:

  1. Working with issues
  2. Authoring code
  3. Disclaimers

Working with issues

We use GitHub Issues to organize all significant work. Any external contributions will first take the form of issues.

Existing issues

Briefly review all open issues for the following reasons:

  • Search for contribution opportunities
  • Verify that your contribution idea is not already in progress

Create an issue (~5 min)

To create a new issue, use the following two (2) templates:

All contributions that are not bug fixes must be pre-approved by the maintainers.

Close an issue

At any time, you can close issues that you create yourself.

Authoring code

Follow these steps when you are ready to begin writing code:

  1. Fork the repository.
  2. Modify your fork using the CLI or GitHub flow.
  3. When your fork contains your finished and tested code, create a pull request.

Exception for minor bug fixes

For single-line bug fixes, you can optionally edit the file directly on the Github website without needing to create a fork.

Best practices for coding

  1. Follow coding best practices such as DRY and SOLID where possible.
  2. Carefully read the pull request template and follow it closely.
  3. Don't include AWS account identifiers or secret keys in your examples.
  4. To conform to licensing expectation, please follow instructions on our Licensing guidelines wiki page.

Automated Tools

The use of AI tooling for assisted development work is accepted and encouraged in this repository, but due to the volume of submissions we ask that you observe the following rules:

  • All issue and pull request submissions to this repository that are sourced by AI must first be reviewed by a human before submitting to the repository. Items reviewed in this way must include a statement like "generated by AI tools, and reviewed by "
  • Please ensure that your submissions are actually improvements. While we are grateful for any proposed fixes, even if they are very small, behavior that looks like creating nuisance PRs or artificially inflating submission counts is not acceptable.
  • We may close issues or pull requests, or limit your ability to interact with this repository, for behavior that in our estimation violates these rules or any of the other rules in this repository's Code of Conduct.

Disclaimers

Review the following important disclaimers before contributing to this project.

Conduct disclaimer

This project abides by the Amazon Open Source Code of Conduct. For additional help, contact opensource-codeofconduct@amazon.com.

Security disclaimer

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.

Licensing disclaimer

See the LICENSE file for this project's licensing.