Contributing

Report an issue in the repository that owns the affected behavior:

• Core issues for decorators and runtime helpers.
• CDK issues for discovery, synthesis, or AWS CDK integration.
• Examples issues for an example application or its setup.

For a proposed change, describe the behavior, the smallest reproducible case, and the tests that demonstrate the intended result. Keep changes scoped to the affected repository and update its documentation or tests when behavior changes.

Core package

From the repository root:

python -m pip install . pytest
python -m pytest -q

The CI workflow also verifies the public import surface with an inline Python command.

CDK integration

From the repository root:

python -m pip install --upgrade pip
python -m pip install --editable . pytest tomli
pytest -q

The package import is checked separately with:

python -c "import lambda_api_decorators_cdk"

Examples

Run these commands from either quickstart-rest or http-api in the examples repository:

python -m pip install -r requirements-dev.txt
pytest -q
cdk synth --quiet

The example workflow also requires the AWS CDK CLI and Docker. Deployment commands require AWS credentials; synthesis and tests are the contribution checks described here.

The documentation site can be checked from this repository with:

corepack enable
yarn install --immutable
yarn typecheck
yarn build