- Reporting Bugs/Feature Requests
- Contributing via Pull Requests
- Conventions
- Finding contributions to work on
- Code of Conduct
- Security issue notifications
- Licensing
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.
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.
Contributions via pull requests are much appreciated. Before sending us a pull request, please ensure that:
- You are working against the latest source on the main branch, unless instructed otherwise.
- You check existing open, and recently merged pull requests to make sure someone else hasn't addressed the problem already.
- You discuss and agree the proposed changes under an existing issue or a new one before you begin any implementation. We value your time and bandwidth. As such, any pull requests created on non-triaged issues might not be successful.
At a high level, these are the steps to get code merged in the repository - don't worry, nearly all of them are automated.
timeline
title Code integration journey (CI)
Project setup <br> (make dev) : Code checkout
: Dependencies
: Git pre-commit hooks
: Local branch
: Local changes
: Local tests
Pre-commit checks <br> (git commit) : Code linting (standards)
: Markdown linting
Pre-Pull Request <br> (git push) : Tests (unit)
Pull Request <br> (CI checks) : Semantic PR title check
: Related issue check
: Acknowledgment check
: Code coverage diff
: Contribution size check
: Contribution category check
: GitHub Actions security check
: Quality checks (SonarCloud)
: End-to-end tests (manual by maintainer)
: +pre-commit & pre-pull request checks
After merge <br> (CI checks) : GitHub Actions security check
: Rebuild Changelog
: Deploy staging docs
: Update draft release
Firstly, fork the repository.
To setup your development environment, we recommend using our pre-configured Cloud environment like Gitpod or GitHub Codespaces.
To start using Gitpod, copy the following URL and replace YOUR_USERNAME with your GitHub username or organization:
https://gitpod.io/#https://github.com/YOUR_USERNAME/aws-lambda-powertools-typescript
This will allow the Cloud environment to target your fork correctly.
To start using GitHub Codespaces, navigate to your fork of the repository, then click on the green Code button, and select Create codespace on <branch_name> under the Codespaces tab (where <branch_name> is the branch you want to work on).
Alternatively, you can use npm run setup-local on your local machine.
To send us a pull request, please follow these steps:
- Create a new branch to focus on the specific change you are contributing e.g.
improv/logger-debug-sampling - Make sure that all formatting, linting, and tests tasks run as git pre-commit & pre-push hooks are passing.
- Commit to your fork using clear commit messages.
- Send us a pull request with a conventional semantic title, and answer any default question in the pull request interface.
- 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.
You might find useful to run both the documentation website and the API reference locally while contributing:
- Docs website:
npm run docs-runLocalDocker- If this is your first time running the docs, you need to build the image:
npm run docs-buildDockerImage
- If this is your first time running the docs, you need to build the image:
- API reference:
npm run docs-api-build-run
| Category | Convention |
|---|---|
| Docstring | We use TypeDoc annotations to help generate more readable API references. For public APIs, we always include at least one Example to ease everyone's experience when using an IDE. |
| Style guide | We use Biome to enforce style and format beyond good practices. We use TypeScript types, function return types, and access modifiers to convey intent. |
| Core utilities | Core utilities always accept serviceName 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 community needs: development productivity, industry leading practices, etc. Both core and general utilities follow our Tenets. |
| Errors | Specific errors thrown by Powertools live within utilities themselves and use Error suffix e.g. IdempotencyKeyError. |
| 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. |
We group tests in different categories
| Test | When to write | Notes | Speed |
|---|---|---|---|
| Unit tests | Verify the smallest possible unit works. | Networking access is prohibited. Keep mocks and spies at minimum. | Fast (ms to few seconds at worst) |
| End-to-end tests | Gain confidence that a Lambda function with our code operates as expected. Also referred to as integration tests. | It simulates how customers configure, deploy, and run their Lambda function - Event Source configuration, IAM permissions, etc. | Slow (minutes) |
| Performance tests | Ensure critical operations won't increase latency and costs to customers. | CI arbitrary hardware can make it flaky. We'll resume writing perf test after we revamp our unit/functional tests with internal utilities. | Fast to moderate (a few seconds to a few minutes) |
NOTE: Unit tests are mandatory. We have plans to create a guide on how to create these different tests. Maintainers will help indicate whether additional tests are necessary and provide assistance as required.
Looking at the existing issues is a great way to find something to contribute on. As our projects, by default, use GitHub issue labels, looking at any 'help-wanted' issues is a great place to start.
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.
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.
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.