Contributing to ColorShades
Before contributing to the project, make sure to fully read the following guide. If some points feel unclear, feel free to ask in the GitHub Discussion.
ColorShades uses yarn workspaces. The website/documentation is located in the /packages/documentation
directory, and the library in the /packages/library
folder.
ColorShades is built with Typescript, if for some reason you decide in your contribution to modify, remove or add types. Make sure to clearly explain in the pull request message why you did it and how it is going to be beneficial for the library or the website.
- Fork this repository to our own GitHub acocunt
- Create a new branch for the feature/fix that you want to implement:
git checkout -b FEATURE_NAME
- If you have not already done so, install yarn
npm install -g yarn
- Install all the dependencies from the workspaces root
yarn
- Run the local project
- If you are working on the website/documentation
yarn workspaces documentation dev
- Working on the library
yarn workspaces library dev
- If you are working on the website/documentation
You may run both of the above commands in seperate terminal windows to see the changes from the library reflect onto the website/documentation
If you would like to export the types for the library, you can so with the following command:
yarn workspaces library types
If you made changes to the default boundaries and would like to regenerate them, you can do so with the following command:
yarn workspaces library boundaries
ColorShades does not include tests, yet. It's definitely one of the top priority on the list of next features. In the meantime, if you want to implement testing in the library, make sure to first open a discussion se we can define together the best testing strategy for the library.