Contributing

Hi there! We're thrilled that you'd like to contribute to this project. Your help is essential for keeping it great.

Contributions to this project are released to the public under the project's open source license.

Submitting a pull request

Fork and clone the repository
Configure and install the dependencies: yarn install
Create a new branch: git checkout -b my-branch-name
Make your changes
Make sure the tests pass: docker buildx bake test
Format code and build javascript artifacts: docker buildx bake pre-checkin
Validate all code has correctly formatted and built: docker buildx bake validate
Push to your fork and submit a pull request
Pat your self on the back and wait for your pull request to be reviewed and merged.

Here are a few things you can do that will increase the likelihood of your pull request being accepted:

Write tests.
Make sure the README.md and any other relevant documentation are kept up-to-date.
We try to follow SemVer v2.0.0. Randomly breaking public APIs is not an option.
Keep your change as focused as possible. If there are multiple changes you would like to make that are not dependent upon each other, consider submitting them as separate pull requests.
Write a good commit message.