Skip to content
This repository has been archived by the owner on Feb 9, 2023. It is now read-only.

Latest commit

 

History

History
42 lines (23 loc) · 1.64 KB

CONTRIBUTING.md

File metadata and controls

42 lines (23 loc) · 1.64 KB

Contributing

Thank you for wanting to contribute. This parser is essential to stylelint's built-in support of CSS-in-JS.

We want to encourage contributions! If you want to participate but couldn't, please give us feedback about what we could do better.

Code contributions

To start coding, you'll need:

  • a minimum of Node.js v10, though we do recommend using the latest LTS release
  • the latest npm

Then:

  1. Fork and clone this repository.
  2. Install all the dependencies with npm ci.

Run tests

Next, you'll want to run the tests using npm test.

However, this runs the test just once.

You can use npm run watch instead. It will run the tests when you change a file.

Additionally, you can run linting checks with npm run lint.

Format code

We use Prettier (with a Husky and lint-staged precommit) to format your code automatically.

Alternatively, you can:

Open a pull request

When you have something to share, it's time to open a pull request.

After we review and merge your pull request, we'll invite you to become a maintainer of the stylelint organization. You'll then be able to work on the repository directly rather than your fork.