CONTRIBUTING.md

Contributing

Welcome, we really appreciate if you're considering to contribute, the joint effort of our contributors make projects like this possible!

The goal of this document is to provide guidance on how you can get involved.

Getting started with bug fixing

In order to make it easier to get familiar with the codebase we labeled simpler issues using Good First Issue and Help Wanted.

Before starting make sure you have the following requirements installed: git, Node, Yarn and Rust.

The process starts by forking the project and setup a new branch to work in. It's important that the changes are made in separated branches in order to ensure a pull request only includes the commits related to a bug or feature.

Clone the forked repository locally and install the dependencies:

git clone https://github.com/USERNAME/lightningcss.git
cd lightningcss
yarn install

Testing

In order to test, you first need to build the core package:

yarn build

Then you can run the tests:

yarn test # js tests
cargo test # rust tests

Building

There are different build targets available, with "release" being a production build:

yarn build
yarn build-release

yarn wasm:build
yarn wasm:build-release

Website

The website is built using Parcel. You can start the development server by running:

yarn website:start