mirror of
https://github.com/resend/react-email.git
synced 2026-09-14 14:18:02 +08:00
Gabriel Miranda
551412c8a2
Co-authored-by: Chris Pennington <cpenn368@gmail.com> Co-authored-by: cpenned <66193019+cpenned@users.noreply.github.com>
31 lines
1.4 KiB
Plaintext
31 lines
1.4 KiB
Plaintext
---
|
|
title: 'Getting Started'
|
|
sidebarTitle: 'Getting Started'
|
|
'og:image': 'https://react.email/static/covers/react-email.png'
|
|
icon: 'hand-wave'
|
|
---
|
|
|
|
Thank you for considering contributing to React Email.
|
|
|
|
We've created this guide to help you better understand how to contribute to the project, even if you've never contributed to an open source project before.
|
|
|
|
## How to report bugs
|
|
|
|
To report a bug, please first read our guide on [opening issues](/contributing/opening-issues).
|
|
|
|
## How to contribute code
|
|
|
|
To open a pull request, please first read our guide on [opening pull requests](/contributing/opening-pull-requests), which outlines our process for RFCs and pull requests.
|
|
|
|
### Codebase overview
|
|
If you need help getting familiar with our codebase, we recommend reading our [Codebase overview guide](/contributing/codebase-overview).
|
|
|
|
### Development workflow guide
|
|
We have also created a Development workflow guide to help you get familiar with the development workflow for React Email. It includes instructions for:
|
|
1. [Setting up your development environment](/contributing/development-workflow/1-setup)
|
|
2. [Running tests](/contributing/development-workflow/2-running-tests)
|
|
3. [Linting](/contributing/development-workflow/3-linting)
|
|
4. [Building](/contributing/development-workflow/4-building)
|
|
5. [Writing documentation](/contributing/development-workflow/5-writing-docs)
|
|
|