We are open to any contributions made by the community.
We use the issue tracker to keep track of bugs and improvements to Prodo and encourage discussion on these issues.
Prodo is a monorepo. Packages are in
packages/. Example apps that use the framework are in examples/.
Fork, then clone the repo:
git clone https://github.com/your-username/prodo.git
Build all packages and examples with:
yarn build
This typechecks all TypeScript and converts it to JavaScript. When developing we recommend building the project in watch mode:
yarn build:watch
Typecheck, lint, and test the entire project:
yarn verify
Only run typechecking and linting:
yarn lint
To apply suggested linting fixes:
yarn lint --fix
Only run tests:
yarn test
We recommend opening an issue with a proposal for a new feature before starting on the work. However, we also welcome pull requests.
The contribution workflow looks like
- Open an new issue in the issue tracker
- Fork the repo
- Create a new feature branch based off the
masterbranch - Make sure all tests pass and there are no linting errors
- Submit a pull request, referencing any issues it addresses
Thanks for contributing!