Skip to content

Latest commit

 

History

History
65 lines (40 loc) · 1.67 KB

CONTRIBUTING.md

File metadata and controls

65 lines (40 loc) · 1.67 KB
Raw

Contributing to aws-coco

We love your input! We want to make contributing to this project as easy and transparent as possible, whether it's:

  • Reporting a bug
  • Discussing the current state of the code
  • Submitting a fix
  • Proposing new features
  • Becoming a maintainer

Pull Requests

We would love your pull requests! If you'd like to propose a change or add a feature, use the following steps:

  1. Fork the repo and create your branch from master.
  2. If you've added code that should be tested, add tests.
  3. Ensure the test suite passes.
  4. Make sure your code lints.
  5. Issue that pull request!

Any contributions you make will be under the MIT Software License

W you submit code changes, your submissions are understood to be under the same MIT License that covers the project. Feel free to contact the maintainers if that's a concern.

Bug Reports

We use GitHub issues to track public bugs. Report a bug by opening a new issue.

License

By contributing, you agree that your contributions will be licensed under its MIT License.

Development

This section contains some guidelines for development.

Environment

This project uses Poetry for dependency management and publishing.

After installing Poetry, you can install the dependencies with:

$ poetry install --dev

Tests

This project uses pytest for tests.

You can run it with the following:

$ poetry run pytest

Formatting

This project uses black for code formatting.

You can run it with the following:

$ poetry run black .