CONTRIBUTING.md

Contributing / Developing

Contributions are welcome. Fork this repository and issue a pull request with your changes.

Please add new tests for new functionality, adapt the existing ones if needed, and make sure that deno test succeeds.

Prerequisites

You need to have Git and deno installed on your system.

Setting up Dev

Just execute these commands:

git clone https://github.com/nestdotland/eggs.git
cd eggs/

This project uses drake to manage project scripts. Run it with Deno:

deno run -A Drakefile.ts
# A shell alias shortcut can be set to run the default drakefile:
alias drake="deno run -A Drakefile.ts"

Versioning

We use SemVer for versioning. For the versions available, see the link to tags on this repository.

Tests

drake test

Style guide

drake format
drake lint

Make sure to use Conventional Commits.

Pull request

Please PR to the dev branch! Then follow the pull request template.

Deploying / Publishing

Submit a pull request after running drake dev to ensure it runs correctly. The module is automatically published to nest.land when a new release is published on github.