-
Notifications
You must be signed in to change notification settings - Fork 4.1k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #8188 from elysahall/gh-pages
Contribution guide updates
- Loading branch information
Showing
19 changed files
with
781 additions
and
191 deletions.
There are no files selected for viewing
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,27 @@ | ||
**To list the available widgets** | ||
|
||
The following ``command-name`` example lists the available widgets in your AWS account. :: | ||
|
||
aws awesomeservice command-name \ | ||
--parameter1 file://myfile.json \ | ||
--parameter2 value2 \ | ||
--lastparam lastvalue | ||
|
||
Contents of ``myfile.json``:: | ||
|
||
{ | ||
"somekey": "some value" | ||
} | ||
|
||
Output:: | ||
|
||
{ | ||
"All of the output": "goes here", | ||
"More Output": [ | ||
{ "arrayitem1": 1 }, | ||
{ "arrayitem2": 2 } | ||
] | ||
"Each indent": "Must be 4 spaces" | ||
} | ||
|
||
For more information, see `This is the topic title <https://example.com>`__ in the *Name of your guide*. |
Binary file not shown.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,24 @@ | ||
# Code contribution quick steps | ||
|
||
Thank you for your interest in contributing to the AWS Command Line Interface (AWS CLI)! This page provides the basic steps for making a contribution to the AWS CLI and linking to detailed information. | ||
|
||
The contribution process is tracked on a publicly visible [GitHub project board](https://github.com/orgs/aws/projects/21). Each lane of the board maps to a stage of the contribution process. | ||
|
||
```{seealso} | ||
For more information on the full contribution process, see the [Detailed contribution process](contribution_process.md). | ||
``` | ||
|
||
## Quick steps | ||
|
||
1. [Create a GitHub issue](contribution_process.md#creating-a-github-issue) with the information necessary to make your contribution. Use the appropriate [GitHub issue template](https://github.com/aws/aws-cli/issues/new/choose). | ||
2. [Maintainers review your issue and request details if needed.](contribution_process.md#github-issue-review-process) Once your issue fulfills all criteria, it is approved for contribution. | ||
3. [Create or update your environment](setup.md). | ||
4. Create a new feature branch in Git. For example Git commits and workflows, see [Git commits and workflows](git_workflows.md). | ||
5. Implement your changes. Ensure you're following the [AWS CLI code guidelines](code_styleguide.md) | ||
6. [Run tests to confirm your contributions pass](testing.md). | ||
7. [Commit and push changes](git_workflows.md#create-a-feature-branch-for-contribution-and-submit-a-pull-request) to your GitHub fork. | ||
8. [Create your pull request (PR)](contribution_process.md#submit-your-pull-request). | ||
9. [Maintainers perform a preliminary review of your PR](contribution_process.md#github-pr-preliminary-review) to confirm the changes are as described in your opened GitHub issue. | ||
10. Once confirmed, maintainers mark your issue and PR as `ready-for-review`. | ||
11. [Maintainers perform a full review of the contribution](contribution_process.md#maintainer-review), providing feedback to the contributor as needed. | ||
12. After the PR is approved by the maintainers, it is marked as `approved` and is then merged. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,12 @@ | ||
# AWS CLI code guidelines | ||
|
||
This page outlines the code guidelines to use when submitting pull requests for the AWS Command Line Interface (AWS CLI). These are the same set of guidelines that the core contributors use when submitting changes, and we ask the same of all community contributions as well. | ||
|
||
The code guidelines include the following: | ||
|
||
* The SDK is released under the [Apache license](http://aws.amazon.com/apache2.0/). Any code you submit will be released under that license. | ||
* We maintain a high percentage of code coverage in our unit tests. As a general rule of thumb, code changes should not lower the overall code coverage percentage for the project. In practice, this means that every bug fix and feature addition should include tests. | ||
* Code should follow the [`pep8`](https://www.python.org/dev/peps/pep-0008/) style guide. If you are modifying an existing module, it is more important for the code to be consistent if there are any discrepancies. Using [`flake8`](https://flake8.pycqa.org/en/latest/) can assist in identifying `pep8` compliance issues. | ||
* Code must work on `python3.7` and higher. | ||
* The AWS CLI is cross platform and code must work on at least Linux, Windows, and Mac OS X. Avoid platform specific behavior. | ||
* To implement support for a significant feature that is not yet available in the AWS CLI, talk to the maintainers beforehand to avoid any duplication of effort. You can [file an issue](https://github.com/aws/aws-cli/issues) in the *AWS CLI GitHub* repository to discuss the feature request further. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.