Contributing
Reporting Issues
If you have found what you think is a bug, please start a discussion.
Also for usage questions, please start a discussion.
Suggesting new features
If you are here to suggest a feature, first start a discussion if it does not already exist. From there, we will discuss use-cases for the feature and then finally discuss how it could be implemented.
Development guide
If you would like to contribute by fixing an open issue or developing a new feature you can use this suggested workflow:
General
- Fork this repository
- Create a new feature branch based off the
main
branch - Follow the Core lib and/or the docs guide below and come back to this once done
- Run
yarn run prettier
to format the code - Git stage your required changes and commit (review the commit guidelines below)
- Submit the PR for review
Core lib
- Install dependencies by running
yarn
. We use version 1 of yarn - Create failing tests for your fix or new feature in the
tests
folder - Implement your changes
- Build the library
yarn run build
(Pro-tip:yarn run build:watch
runs the build in watch mode) - Run the tests and ensure that they pass. (Pro-tip:
yarn test:dev
runs the test in watch mode) - You can use
yarn link
oryalc
to sym-link this package and test it locally on your own project. Alternatively, you may use CodeSandbox CI’s canary releases to test the changes in your own project (requires a PR to be created first) - Follow step 4 and onwards from the general guide above to bring it to the finish line
Docs
- Navigate to the
website
folder. Eg.cd website
- Install dependencies by running
yarn
in thewebsite
folder We use version 1 of yarn - Run
yarn dev
to start the dev server - Navigate to
http://localhost:9000
to view the docs - Naivgate to the
docs
folder and make necessary changes to the docs - Add your changes to the docs and see them live reloaded in the browser
- Follow step 4 and onwards from the general guide above to bring it to the finish line
Type
We follow the conventional commit spec for our commit messages. Please review the spec for more details.
Your commit type must be one of the following:
- build: Changes that affect the build system or external dependencies (example scopes: yarn, npm, rollup, etc.)
- ci: Changes to our CI configuration files and scripts (example scopes: GitHub Actions)
- docs: Documentation only changes
- feat: A new feature
- fix: A bug fix
- perf: A code change that improves performance
- refactor: A code change that neither fixes a bug nor adds a feature
- style: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)
- test: Adding missing tests or correcting existing tests
Pull requests
Please try to keep your pull request focused in scope and avoid including unrelated commits.
After you have submitted your pull request, we’ll try to get back to you as soon as possible. We may suggest some changes or request improvements, therefore, please check ✅ “Allow edits from maintainers” on your PR
Thank you for contributing!