Dawn James 8ce12027dd

Return correct error when creating a bucket with empty CreateBucketConfiguration (#3079 )

* Several updates to the contributor documentation with extra information.

* Fix failing test by providing a region.

* Create test for issue 2210.

* Check if CreateBucketConfiguration is supplied and empty; raise MalformedXML error if so.

2020-06-19 11:44:43 +01:00

2.4 KiB

Raw Blame History

Contributing code

Moto has a Code of Conduct, you can expect to be treated with respect at all times when interacting with this project.

Running the tests locally

Moto has a Makefile which has some helpful commands for getting set up. You should be able to run make init to install the dependencies and then make test to run the tests.

NB. On first run, some tests might take a while to execute, especially the Lambda ones, because they may need to download a Docker image before they can execute.

Linting

Run make lint or black --check moto tests to verify whether your code confirms to the guidelines.

Getting to grips with the codebase

Moto maintains a list of good first issues which you may want to look at before implementing a whole new endpoint.

Missing features

Moto is easier to contribute to than you probably think. There's a list of which endpoints have been implemented and we invite you to add new endpoints to existing services or to add new services.

How to teach Moto to support a new AWS endpoint:

Search for an existing issue that matches what you want to achieve.
If one doesn't already exist, create a new issue describing what's missing. This is where we'll all talk about the new addition and help you get it done.
Create a pull request and mention the issue # in the PR description.
Try to add a failing test case. For example, if you're trying to implement boto3.client('acm').import_certificate() you'll want to add a new method called def test_import_certificate to tests/test_acm/test_acm.py.
If you can also implement the code that gets that test passing that's great. If not, just ask the community for a hand and somebody will assist you.

Maintainers

Releasing a new version of Moto

You'll need a PyPi account and a DockerHub account to release Moto. After we release a new PyPi package we build and push the motoserver/moto Docker image.

First, scripts/bump_version modifies the version and opens a PR
Then, merge the new pull request
Finally, generate and ship the new artifacts with make publish

2.4 KiB Raw Blame History