Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
58 lines (38 loc) · 2.87 KB

CONTRIBUTING.md

File metadata and controls

58 lines (38 loc) · 2.87 KB
Raw

Contributing in this repository

We 💛 contributions! The rules for contributing to this org are few:

  1. Don't be a jerk
  2. Search issues before opening a new one
  3. Lint and run tests locally before submitting a PR
  4. Adhere to the code style the project has chosen

Repo Info

The jsx-email repository is a Monorepo that uses two primary tools: pnpm and Moon. pnpm is used for package management and workspace management. Moon is used as our task runner. Repo checks, tests, and builds should be run through Moon.

JSX email v3 requires Node.js v22.0.0 or newer and React v19.1.0 or newer.

Getting Started

If you're new to either pnpm or Moon you'll want to run the bootstrap.sh script first. It will install everything you'll need to get started, and bootstrap your environment:

$ ./shared/bootstrap.sh

Next we'll want to get dependencies installed, and get everything built. (Note: One of the benefits of Moon is that it uses intelligent caching to assert that dependencies are always up to date before running any command. We don't technically have to install dependencies first):

$ pnpm install

Then build all the things:

$ moon repo:build.all --cache off

Before Committing

  1. Use at least Node.js v22.0.0 or higher. NVM can be handy for switching between Node versions.
  2. Lint your changes via moon run :lint. Fix any errors before committing.
  3. Format your changes via moon run :format.
  4. Typecheck your changes via moon run :typecheck.
  5. Test your changes via moon run :test. Only Pull Requests with passing tests will be accepted.

Submitting Code

Any code change should be submitted as a pull request. Our guidelines for Pull Requests:

  • Please fill in our template in its entirety. Please don't reformat it or modify it
  • The description should explain what the code does and give steps to execute it
  • The pull request should also contain tests
  • Before submitting your Pull Request, please run moon run :lint, moon run :format, moon run :typecheck, and moon run :test in the root directory
  • If any checks fail for your Pull Request, please resolve them. Always feel free to ask for help if unable to resolve issues with checks

Code Review Process

The bigger the pull request, the longer it will take to review and merge. Try to break down large pull requests in smaller chunks that are easier to review and merge.

It is also always helpful to have some context for your pull request. What was the purpose? Why does it matter to you? Does it resolve any known Github issues? Adding a line "resolves #<issue number>" (e.g. "resolves #23") to the description of your pull request or of a specific commit will automatically close this issue once the pull request is merged.