Skip to content

Latest commit

 

History

History
32 lines (19 loc) · 1.89 KB

CONTRIBUTING.md

File metadata and controls

32 lines (19 loc) · 1.89 KB
Raw

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 setup. You should be able to run make init to install the dependencies and then make test to run the tests.

Linting

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

Is there a missing feature?

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:

  • Create an 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