First off, thank you for considering contributing to
wpackio. It's people like you that make
wpackio such a great tool.
How to contribute
- Familiarity with pull requests and issues.
- Concepts of monorepo and lerna.
- A strong passion
Now let's dive in.
Create a package
We use plopjs to automate boilerplate package generation.
Use it to create a new package.
Now go through the questions and a new package will be created for you.
Run all tests through jest.
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
We don't use
tsc to compile, we use
`yarn lerna publish
This will bump version and publish. Make sure you have access to
@wpackio npm org
or ask a maintainer.
yarn lerna publish --canary --preid next
RELEASING CANARY FOR NEXT MAJOR VERSION
yarn lerna publish premajor --canary --preid beta --dist-tag next
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.
Thank you to all our backers! [Become a backer]
Thank you to all our sponsors! (please ask your company to also support this open source project by becoming a sponsor).