1
0
Fork 0
mirror of https://github.com/ansible-collections/community.general.git synced 2024-09-14 20:13:21 +02:00

Update GUIDELINES.md

Edited for grammar and clarity.
This commit is contained in:
scottb 2017-02-22 00:44:14 -08:00 committed by Brian Coca
parent 96d952a998
commit 3812c76168

View file

@ -2,13 +2,13 @@
## Getting Started ## Getting Started
Since Ansible 2.0, it is a requirement that all new AWS modules are written to use boto3. Since Ansible 2.0, it is required that all new AWS modules are written to use boto3.
Prior to 2.0, modules may have been written in boto or boto3. The effort to port all modules to boto3 has begun. Prior to 2.0, modules may have been written in boto or boto3. The effort to port all modules to boto3 has begun.
## Bug fixing ## Bug fixing
When possible the code should be ported to use boto3, bug fixes to code that relies on boto will still be accepted. Bug fixes to code that relies on boto will still be accepted. When possible, the code should be ported to use boto3.
## Naming your module ## Naming your module
@ -23,8 +23,8 @@ AWS, that's fine, but don't create new ones independently
## Adding new features ## Adding new features
Try and keep backward compatibility with relatively recent Try to keep backward compatibility with relatively recent
versions of boto3. That means that if want to implement some versions of boto3. That means that if you want to implement some
functionality that uses a new feature of boto3, it should only functionality that uses a new feature of boto3, it should only
fail if that feature actually needs to be run, with a message fail if that feature actually needs to be run, with a message
saying which version of boto3 is needed. saying which version of boto3 is needed.