Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
96 lines (63 loc) · 1.61 KB

CONTRIBUTING.md

File metadata and controls

96 lines (63 loc) · 1.61 KB
Raw

Contributing

Thank you for considering contributing to the Lettr PHP SDK!

Development Setup

  1. Fork and clone the repository
git clone https://github.com/TOPOL-io/lettr-php.git
cd lettr-php
  1. Install dependencies
composer install
  1. Create a new branch
git checkout -b feature/your-feature-name

Code Style

This project uses Laravel Pint for code formatting.

# Check code style
composer lint -- --test

# Fix code style
composer lint

Static Analysis

This project uses PHPStan at level 8.

composer analyse

Testing

This project uses Pest for testing.

# Run tests
composer test

# Run specific test file
./vendor/bin/pest tests/Unit/LettrTest.php

Pull Request Process

  1. Ensure all tests pass
composer lint -- --test
composer analyse
composer test

  1. Update documentation if needed

  2. Create a pull request with a clear description of changes

  3. Wait for review

Commit Messages

Use clear, descriptive commit messages:

  • feat: add webhook retry configuration
  • fix: handle empty response body
  • docs: update installation instructions
  • test: add email builder tests
  • refactor: simplify domain verification logic

Reporting Issues

When reporting issues, please include:

  • PHP version
  • SDK version
  • Minimal code example to reproduce
  • Expected vs actual behavior
  • Error messages (if any)

Security Vulnerabilities

If you discover a security vulnerability, please email security@lettr.com instead of using the issue tracker.