Skip to main content
Thank you for considering contributing to React Email. This guide will help you understand how to contribute to the project, whether you’re reporting bugs, suggesting features, or submitting code changes.

​
How to Report Bugs

If you’ve found a bug in React Email, please follow our guide on opening issues to report it properly. Good bug reports help us fix issues faster and improve the project for everyone.

​
How to Contribute Code

Before submitting code changes, please read our guide on opening pull requests. This guide outlines our process for:
  • Proposing changes through RFCs (Request for Comments)
  • Submitting pull requests
  • Code review expectations

​
Understanding the Codebase

If you’re new to the React Email codebase, we recommend starting with our Codebase overview guide. This will help you understand:
  • Project structure
  • How components are organized
  • Key architectural decisions
  • Where to find specific functionality

​
Development Workflow

Our development workflow guide provides step-by-step instructions for working with the React Email codebase:

​
1. Setting Up Your Development Environment

Learn how to fork the repository, install dependencies, and configure your local environment. View setup guide

​
2. Running Tests

Understand how to run the test suite, write new tests, and ensure your changes don’t break existing functionality. View testing guide

​
3. Linting

Learn about our code style standards and how to ensure your code follows our linting rules. View linting guide

​
4. Building

Understand how to build the project and verify that your changes compile correctly. View building guide

​
5. Writing Documentation

If your contribution includes new features or changes to existing functionality, learn how to document them properly. View documentation guide

​
Getting Help

If you need help with your contribution:

​
Code of Conduct

We expect all contributors to follow our code of conduct. Be respectful, inclusive, and collaborative when interacting with the community.

​
What to Contribute

Not sure where to start? Here are some ways you can contribute:
  • Fix bugs reported in issues
  • Improve documentation
  • Add tests to increase code coverage
  • Implement new components
  • Enhance existing components
  • Improve developer experience
Look for issues labeled “good first issue” if you’re new to the project.

​
License

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

Build docs developers (and LLMs) love

Get started for freeTalk to us