Skip to content
Permalink
Branch: master
Find file Copy path
Find file Copy path
Fetching contributors…
Cannot retrieve contributors at this time
82 lines (50 sloc) 3.89 KB

Contributing

First off, thank you for considering contributing to wpackio. It's people like you that make wpackio such a great tool.

How to contribute

Prerequisites:

Now let's dive in.

Create a package

We use plopjs to automate boilerplate package generation.

Use it to create a new package.

yarn plop

Now go through the questions and a new package will be created for you.

Test

yarn test

Run all tests through jest.

Writing code

We use typescript to write code in this repository. It helps avoid many runtime bugs and a better type system goes a long way to maintain a project.

So please edit files under src of every package. For editor, I would suggest using πŸ†šCode.

We don't use tsc to compile, we use babel 7.

Publish

`yarn lerna publish

This will bump version and publish. Make sure you have access to @wpackio npm org or ask a maintainer.

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 wpackio!

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).


You can’t perform that action at this time.