Contributing

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

Quick Start¶

# Fork and clone the repository
git clone https://github.com/YOUR_USERNAME/aws-lambda-handler-cookbook.git
cd aws-lambda-handler-cookbook

# Set up development environment
make dev

# Run all checks before submitting
make pr

Reporting Bugs/Feature Requests¶

Before Opening an Issue

Check existing open issues to avoid duplicates.

Use the GitHub issue tracker to:

Report bugs
Suggest new features
Propose documentation improvements

Contributing via Pull Requests¶

Open an Issue First

Please open an issue before starting implementation. This ensures alignment and saves your time.

Pull Request Process¶

Fork the repository
Create a branch for your change (e.g., feature/add-new-utility)
Make your changes following the code style
Run checks: make pr
Commit with conventional commit messages:
- feat: for new features
- fix: for bug fixes
- docs: for documentation
- chore: for maintenance
Open a Pull Request

Commit Message Format¶

<type>: <description>

[optional body]

Examples:

feat: add retry mechanism for DynamoDB operations
fix: handle empty response from AppConfig
docs: update getting started guide

Development Setup¶

Local Development¶

# Install dependencies
make dev

# Run tests
make unit
make integration
make e2e

# Run all PR checks
make pr

# Start local docs server
make docs

Makefile Commands¶

Command	Description
`make dev`	Set up development environment
`make pr`	Run all checks before PR submission
`make unit`	Run unit tests
`make integration`	Run integration tests
`make e2e`	Run end-to-end tests
`make lint`	Run linting and type checks
`make format`	Format code
`make docs`	Start local documentation server

Code of Conduct¶

Please read our Code of Conduct before contributing.

License¶

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