Skip to content

Latest commit

 

History

History
111 lines (68 loc) · 6.5 KB

CONTRIBUTING.md

File metadata and controls

111 lines (68 loc) · 6.5 KB
Raw

Contributing

Wiki

See (and edit!) our public Wiki.

Useful notes for new contributors:

https://github.com/parcel-bundler/parcel/wiki/Contributing

We encourage you to create new pages or make helpful edits to all parts of the wiki. Try to ask before making major changes to pages you didn't create, but just do whatever you think is best. Feel free to make a user page and collect your notes there so everyone can learn.

Slack

Join our public Slack: https://slack.parceljs.org/

The #contributors channel is useful. If you want help or have questions about any aspect of Parcel development, ask there! We'll see and respond.

It's important to us to give a good experience to new contributors, so anything you want to do is fair game. Feel free to come chat about it, or open a new issue with RFC in the title.

Overview

  • yarn install - install all dependencies
  • yarn build - run src/ through babel into lib/
  • yarn test - run all tests in repo
  • yarn format - run prettier on all files

Getting Started

To get started with the project:

You'll need Git, Node, and Yarn installed. Then clone the repository:

git clone git@github.com:parcel-bundler/parcel.git && cd parcel

Run Yarn:

yarn install

Run tests:

yarn test

Environment variables, command line arguments

You can set PARCEL_WORKERS to the number of worker processes to spawn.

NOTE: PARCEL_WORKERS=0 is handy for debugging, because all code will run on the main thread. You can then place breakpoints in Asset code. (Normally these breakpoints won't trigger, because the code executes in a subprocess.)

NOTE: When developing plugins or new Asset types, run with --no-cache (or pass cache: false to Bundler options). Parcel uses caching by default, but during development you'll normally pass incomplete results into the cache. This can leave you wondering why you're constantly seeing old results.

You can set PARCEL_MAX_CONCURRENT_CALLS to change the limit of concurrent calls per worker.

Link to local parcel build

While contributing to parcel, you may need to run a local version of parcel and set it as the global cli option in your command line, so that when you run parcel ..., it will find your new local variant of parcel instead of the global package installed before (if you had it installed globally before).

To do this, you have multiple options:

  • If you had parcel installed globally, you can run yarn global remove parcel and then cd to your own copy of parcel and run yarn link. This way, the global parcel in your PATH would reference to the local copy. To make sure you have it installed globally, just run parcel --version.

  • Another option would be to run yarn link in your own copy of parcel directory and then go to the directory, which you want to test your copy of parcel in, and run yarn link parcel-bundler, so that locally your copy of parcel is the one used in its npm scripts.

  • Another way, which we highly recommend if you plan to switch between different parcel sources often, is to create some terminal aliases. This way you can have different aliases for each of the versions of parcel you wish to maintain on your machine. For example, you can make an alias called parcelfork pointing to your fork of parcel for development, and then parceldev pointing to a clone of the parcel repo for experimenting with the latest changes, and then still keep the original parcel command pointing to the npm installed stable version. To do this, add some aliases to your terminal’s startup file (usually .bashrc) in the format alias [name]=“node [path_to_new_parcel_bin_file]” for each of the sources you want to use. For example: alias parcelfork=“node ~/my/path/to/fork/bin/cli.js”

For more information on this topic, read this issue on parcel repository.

Financial contributions

We also welcome financial contributions in full transparency on our open collective. Anyone can file an expense. If the expense makes sense for the development of the community, it will be "merged" in the ledger of our open collective by the core contributors and the person who filed the expense will be reimbursed.

Credits

Contributors

Thank you to all the people who have already contributed to parcel!

Backers

Thank you to all our backers! [Become a backer]

Sponsors

Thank you to all our sponsors! (please ask your company to also support this open source project by becoming a sponsor)