From d37bfe2aa85d79caa113a3c791081964787df3bd Mon Sep 17 00:00:00 2001 From: Tristan F Date: Mon, 16 Jan 2023 18:22:05 -0500 Subject: [PATCH 1/3] docs: add contributing guide --- CONTRIBUTING.md | 55 +++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 55 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 00000000..fb6facb3 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,55 @@ +# 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](https://github.com/parcel-bundler/lightningcss/issues?q=is%3Aopen+is%3Aissue+label%3A%22good+first+issue%22) and [Help Wanted](https://github.com/parcel-bundler/lightningcss/issues?q=is%3Aopen+is%3Aissue+label%3A%22good+first+issue%22+label%3A%22help+wanted%22). + +Before starting make sure you have the following requirements installed: [git](https://git-scm.com), [Node](https://nodejs.org), [Yarn](https://yarnpkg.com) and [Rust](https://www.rust-lang.org/tools/install). + +The process starts by [forking](https://docs.github.com/en/github/getting-started-with-github/fork-a-repo) 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: + +```sh +git clone https://github.com/USERNAME/lightningcss.git +cd parcel +yarn install +``` + +## Testing + +In order to test, you first need to build the core package: + +```sh +yarn build +``` + +Then you can run the tests: + +```sh +yarn test +``` + +## Building + +There are different build targets available, with "release" being a production build: + +```sh +yarn build +yarn build-release + +yarn wasm:build +yarn wasm:build-release +``` + +## Website + +The website is built using [Parcel](https://parceljs.org). You can start the development server by running: + +```sh +yarn website:start +``` \ No newline at end of file From d26e48e04cf7f07cb0753f41fe41b0a89fa12acf Mon Sep 17 00:00:00 2001 From: Tristan F Date: Mon, 16 Jan 2023 18:22:45 -0500 Subject: [PATCH 2/3] docs: fix parcel reference --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index fb6facb3..5a63d37f 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -16,7 +16,7 @@ Clone the forked repository locally and install the dependencies: ```sh git clone https://github.com/USERNAME/lightningcss.git -cd parcel +cd lightningcss yarn install ``` From 70bad3629df7af7360e86515c8e02c048cee39d5 Mon Sep 17 00:00:00 2001 From: Tristan F Date: Wed, 25 Jan 2023 07:13:17 -0500 Subject: [PATCH 3/3] docs(contributing): add testing for rust --- CONTRIBUTING.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 5a63d37f..e8141154 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -31,7 +31,8 @@ yarn build Then you can run the tests: ```sh -yarn test +yarn test # js tests +cargo test # rust tests ``` ## Building @@ -52,4 +53,4 @@ The website is built using [Parcel](https://parceljs.org). You can start the dev ```sh yarn website:start -``` \ No newline at end of file +```