We want to make contributing to this project as approachable and transparent as possible.
- Install required dependencies on root project by run
yarn install - Install all mono-repository dependencies by run
yarn modules bootstrap - Get start with
yarn modules test
you can copy code from example package. The src and package.json is a mandatory, other are based on your need.
- For typescript built-in compiler (
icompiler-tsc) - It's built-in @kcinternal/commandline no need to do anything else. - For typescipt webpack compiler (
icompiler-webpack) - The webpack.config.js and tsconfig.json is required. - For eslint support with webpack - The .eslintrc.js is required. but if you only need formatting in IDE, nothing is required.
- For testing (
itester) - The jest.config.js is required.
- Fork the repo and create your branch from
master. - Pull all changes from
developif it not up to date. - If you've added code, add tests to coverage at least 80% of new code added.
- If you've changed APIs, update the documentation (README.md file on each modules).
- Ensure all test suite passes.
- Make sure your code lints.
I use GitHub issues to track public bugs. Please ensure your description is clear and has sufficient instructions to be able to reproduce the issue.
By contributing to KCUtils, you agree that your contributions will be licensed under its CC-BY-SA 4.0
This document was adapted from the open-source contribution guidelines for Facebook's Draft