waitlist-mailer/CONTRIBUTING.md

Modern, modular TypeScript library for managing waitlists with pluggable storage and mail providers. Supports MongoDB, SQL databases, and custom adapters with zero required dependencies for basic usage.

# Contributing to WaitlistMailer

Welcome! We're excited to have you contribute to this project.

## How to Contribute

1. **Fork the Repository**: Click the "Fork" button on GitHub.
  
2. **Clone Your Fork**:
  
  ```
  git clone [https://github.com/YOUR_USERNAME/waitlist-mailer.git](https://github.com/YOUR_USERNAME/waitlist-mailer.git)
  cd waitlist-mailer
  ```
  
3. **Create a Branch**: `git checkout -b feature/your-feature-name`
  
4. **Make Changes**: Write clean, well-documented code.
  
5. **Run Tests**: Ensure all tests pass.
  
  ```
  npm test
  ```
  
6. **Commit**: Use clear commit messages (e.g., `feat: add redis adapter`).
  
7. **Push**: `git push origin feature/your-feature-name`
  
8. **Open a Pull Request**: Describe your changes clearly.
  

## Coding Standards

- Use **TypeScript** for all code.
  
- Follow the existing style and directory structure.
  
- Add comments for complex logic.
  
- Ensure 100% type safety.
  

## Bug Reports

If you find a bug, please open an issue with:

- A clear title.
  
- Steps to reproduce.
  
- Expected vs actual behavior.