Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
33 lines (23 loc) · 1.29 KB

CONTRIBUTING.md

File metadata and controls

33 lines (23 loc) · 1.29 KB

Contributing

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!

Environment

  • You will at least need nodejs and yarn. 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.

Making Changes

Pull requests are encouraged. If you want to add a feature or fix a bug:

  1. Fork and clone locally the repository

  2. Create a separate branch for your changes (git checkout -b <name>)

  3. Apply your changes, format with prettier before creating a commit

  4. 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 rungit commit and you will be promped to use the commitizen helper.

  5. 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!