Skip to content

Latest commit

 

History

History
26 lines (18 loc) · 1.38 KB

CONTRIBUTING.md

File metadata and controls

26 lines (18 loc) · 1.38 KB

Contributing to this project

First of all, welcome and thank you for your willingness to help! Please review the suggested steps below to ensure that your contribution is approved.

When contributing to this repository, please first discuss the change you wish to make via issue, email, or any other method with the owners of this repository before making a change.

Please note we have a code of conduct, so follow it in all your interactions with the project.

Pull Request Process

  1. Ensure any install or build dependencies are removed before the end of the layer when doing a build.
  2. Update the README.md with details of changes to the interfaces, new typeclass instances, etc.
  3. Increase the version numbers in any examples files and the README.md to the new version that this Pull Request would represent. The versioning scheme we use is SemVer.
  4. Your Pull Request will be reviewed by the project authors, and merged when no questions are left.

Setting up the project locally

  1. Make sure to install the dependencies via npm ci command. It is crucial to use the same versions of packages which are fixed in package-lock.json file.
  2. Make your changes and ensure that all tests or other checks complete without any warnings or errors.

This file is a subject to change as the project evolves, so please be sure to review its changes.