AWS CLI code example contribution quick steps

Danger

The AWS CLI repository is a public GitHub repository and submitting examples before a feature launch produces issues. You must be able to run the command from the public installation source.

Thank you for your interest in contributing code examples to the AWS Command Line Interface (AWS CLI)! This page provides the basic steps for making a contribution to AWS CLI code examples.

Quick steps

1. Create or update your environment.

2. Create a new feature branch in Git. For example Git commits and workflows, see Git commits and workflows.

3. Add your code example updates.

   • All AWS CLI command examples must adhere to the AWS CLI code examples style guide and be real working/tested examples.

   • The command examples are located in the repository’s /aws-cli/awscli/examples folder. For details, see Example file location.

4. Run the test_examples.py test to confirm your contributions pass.

   • If the test_examples.py test does not pass, fix the errors in your examples until they all pass.

5. Commit and push changes to your GitHub fork.

6. Create your pull request (PR).

7. Maintainers perform a preliminary review of your PR to confirm the changes are as described.

8. Once confirmed, maintainers mark your issue and PR as ready-for-review.

9. A full review of the contribution is performed by both the maintainers and the AWS CLI documentation writer, providing feedback to the contributor as needed.

10. After the PR is approved by the maintainers and AWS CLI doc writer, it is marked as approved and is then merged.