We're extremely delighted that you want to contribute to quercia! This project is open and shaped by the community, so your help is much appreciated!
- You will at least need
nodejs
andyarn
. Even better if you use volta to manage your toolchain because we use it too! - A go runtime is recommended to test the included library, but not mandatory.
Pull requests are encouraged. If you want to add a feature or fix a bug:
-
Fork and clone locally the repository
-
Create a separate branch for your changes (
git checkout -b <name>
) -
Apply your changes, format with prettier before creating a commit
-
Create a changeset by running
yarn changeset
. more on that here.NOTE: you can create commits manually with git, but your last commit must be created via
changeset
NOTE(2): git commits follow the conventional style guideline; don't worry tough! just run
git commit
and you will be promped to use thecommitizen
helper. -
Push to your fork and open a PR
We make our best effort to ensure that PRs are reviewd and merged as quickly as possible. It can take as little as an hour if everyting looks good!