Skip to content

Latest commit

 

History

History
94 lines (63 loc) · 6.35 KB

CONTRIBUTING.md

File metadata and controls

94 lines (63 loc) · 6.35 KB
Raw

Contributing Guidelines

Thank you for your interest in contributing to our project. Whether it's a bug report, new feature, correction, or additional documentation, we greatly value feedback and contributions from our community.

Please read through this document before submitting any issues or pull requests to ensure we have all the necessary information to effectively respond to your bug report or contribution.

Reporting Bugs/Feature Requests

We welcome you to use the GitHub issue tracker to report bugs, suggest features, or documentation improvements.

When filing an issue, please check existing open, or recently closed, issues to make sure somebody else hasn't already reported the issue. Please try to include as much information as you can.

Contributing via Pull Requests

We are temporarily de-prioritizing and pausing external contributions until end of July 2022. You can read more here: aws-powertools#1076

Dev setup

To send us a pull request, please follow these steps:

  1. Fork the repository.
  2. Install dependencies in a virtual env with poetry, and pre-commit hooks: make dev
  3. Create a new branch to focus on the specific change you are contributing e.g. improv/logger-debug-sampling
  4. Run all tests, and code baseline checks: make pr
    • Git hooks will run linting and formatting while make pr run deep checks that also run in the CI process
  5. Commit to your fork using clear commit messages.
  6. Send us a pull request with a conventional semantic title, and answering any default questions in the pull request interface.
  7. Pay attention to any automated CI failures reported in the pull request, and stay involved in the conversation.

GitHub provides additional document on forking a repository and creating a pull request.

Local documentation

You might find useful to run both the documentation website and the API reference locally while contributing:

  • API reference: make docs-api-local
  • Docs website: make docs-local
    • If you prefer using Docker: make docs-local-docker

Conventions

Category Convention
Docstring We use a slight variation of Numpy convention with markdown to help generate more readable API references.
Style guide We use black as well as flake8 extensions to enforce beyond good practices PEP8. We use type annotations and enforce static type checking at CI (mypy).
Core utilities Core utilities use a Class, always accept service as a constructor parameter, can work in isolation, and are also available in other languages implementation.
Utilities Utilities are not as strict as core and focus on solving a developer experience problem while following the project Tenets.
Exceptions Specific exceptions live within utilities themselves and use Error suffix e.g. MetricUnitError.
Git commits We follow conventional commits. We do not enforce conventional commits on contributors to lower the entry bar. Instead, we enforce a conventional PR title so our label automation and changelog are generated correctly.
API documentation API reference docs are generated from docstrings which should have Examples section to allow developers to have what they need within their own IDE. Documentation website covers the wider usage, tips, and strive to be concise.
Documentation We treat it like a product. We sub-divide content aimed at getting started (80% of customers) vs advanced usage (20%). We also ensure customers know how to unit test their code when using our features.

Finding contributions to work on

Looking at the existing issues is a great way to find something to contribute on. As our projects, by default, use the default GitHub issue labels (enhancement/bug/help wanted/invalid/question/documentation), looking at any 'help wanted' issues is a great place to start.

Code of Conduct

This project has adopted the Amazon Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact [email protected] with any additional questions or comments.

Security issue notifications

If you discover a potential security issue in this project we ask that you notify AWS/Amazon Security via our vulnerability reporting page. Please do not create a public github issue.

Troubleshooting

API reference documentation

When you are working on the codebase and you use the local API reference documentation to preview your changes, you might see the following message: Module aws_lambda_powertools not found.

This happens when:

  • You did not install the local dev environment yet
    • You can install dev deps with make dev command
  • The code in the repository is raising an exception while the pdoc is scanning the codebase
    • Unfortunately, this exception is not shown to you, but if you run, poetry run pdoc --pdf aws_lambda_powertools, the exception is shown and you can prevent the exception from being raised
    • Once resolved the documentation should load correctly again

Licensing

See the LICENSE file for our project's licensing. We will ask you to confirm the licensing of your contribution.

We may ask you to sign a Contributor License Agreement (CLA) for larger changes.