Skip to content

Latest commit

 

History

History
87 lines (54 loc) · 1.67 KB

CONTRIBUTING.md

File metadata and controls

87 lines (54 loc) · 1.67 KB
Raw

Contributing

Setup git hooks

It is recommended to setup git hooks to ensure code quality and consistency.

To setup git hooks, run the following:

git config core.hooksPath .githooks

Install Deno

Note: This project uses Deno version >= 1.38.x

Via asdf

Guide

Once asdf is installed, run the following:

asdf install

Via Deno docs

Guide

Install Docker

Install Docker

Testing

Note: Before running the tests, ensure the above pre-requisites are are satisfied and Docker is up and running.

To run tests, run the following:

deno task test

Coverage

To check coverage, run the following:

deno task cov:check

To check report, run the following:

deno task report

Cache

Deno uses a cache as defined here. Sometimes, this can get out of sync with the latest available dependencies. To reload the cache, run the following:

deno task reload

Release Process

To release a new version, take the following steps:

  • Bump the version by running the version_bump GitHub Action and choose the appropriate version bump:

version-bump

  • Wait for the Pull Request to be created and merge this into main.

  • Wait for the main branch action to complete.

  • Find the created draft release and publish it.