CONTRIBUTING.md

Contributing

Woo! You want to contribute to this project? That's awesome! Here are some guidelines to get you started.

Getting Started

1. Fork this repository
2. Clone your forked repository to your local machine
3. Setup the project

yarn
yarn dev

This will setup the project to watch for changes and start a local server at localhost:3000.

The React package is found in packages/prettyavatars and the website is found in packages/website.

Publishing a Release

Run yarn release to publish a new release. Lerna will take care of everything for you.