Thank you for considering contributing to ✨ polished. Below you will find useful information for contributing including how to setup the library, how to work with it in development, and how to commit.
Is this your first Pull Request on GitHub? Learn more by reading How to Contribute to an Open Source Project on GitHub.
Want to know where you can help? Check out our active issues for places to start.
Important - Have an idea for a new module? Please file an issue first as we use these issues to gauge interest in any particular feature. The nature of ✨ polished means we could almost include anything, so this helps us narrow our focus. If you submit a PR directly for a new feature, without a corresponding issue, that PR will be closed.
Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.
✨ polished supports both npm and yarn. If using yarn just substitute the below commands with the yarn equivalent.
npm installHere are some useful commands for development:
- Run tests via
npm test. - Update Jest snapshots via
npm test -- -u. - Rebuild library and docs with every change via
npm run build:watch - Serve the docs locally via
npm run docs.
✨ polished uses semantic-release to do automatic releases and generate a changelog based on the commit history. In order for this to work, we follow this convention for commit messages.
commitizen is installed to help you follow this convention.
Once you are ready to commit your changes, just use the following commands:
git add <files to be committed>git cz
Then you just simply follow the prompts to craft your commit message.