Skip to content

Latest commit

 

History

History
56 lines (36 loc) · 2.5 KB

CONTRIBUTING.md

File metadata and controls

56 lines (36 loc) · 2.5 KB
Raw

Contributing

Much of the prelude of the Babel contribution guide also applies for this project, since it operates on and with Babel plugins. In particular:

This project is written with TypeScript, a superset of JavaScript that allows explicit type annotations and includes a type checker.

Developing

codemod expects at least node 16 and pnpm. You can check each of these with node -v and pnpm -v. Look for instructions on installing node here and pnpm here.

Setup

$ git clone https://github.com/codemod-js/codemod
$ cd codemod
$ pnpm install

Then make sure the tests pass:

$ pnpm test

Running linting/testing

We use ESLint. To run ESLint on the project, run:

$ pnpm lint

To automatically fix some of the issues ESLint finds:

$ pnpm lint:fix

The tests in this project are written using Jest and, like the non-test code, are also written in TypeScript. To run the tests:

$ pnpm test

Submitting Changes

We accept pull requests for bug fixes and improvements. For non-trivial changes it's usually a good idea to open an issue first to track the bug you'd like to fix or discuss the improvement you'd like to contribute.

A good pull request…

  • Is tested. Any bugs fixed should have a test that fails without the fix. Any features added should have tests covering the expected usage and expected failures.
  • Is documented. Reference any existing issues that your pull request addresses. Provide a reasonable description in the pull request body. Documentation of expected usage for new features is required. Documentation is generally not needed for bug-fix pull requests, but sometimes a bug happened because an API was poorly understood. Consider improving the documentation such that a similar bug would not be introduced in the future.
  • Is narrow in scope. Pull requests that make broad, sweeping changes are generally a bad idea. Instead, larger refactors or improvements should be broken down into multiple smaller pull requests.