CONTRIBUTING.md

Contributing

Table of contents

• Contributing
  • Table of contents
  • Setting Up the Environment
  • Submitting a Pull Request (PR)
  • Code Style Guidelines

Setting Up the Environment

1. Install Deno following the official documentation if not installed.
2. Run deno cache --reload --lock=deno.lock src/main.ts to cache dependencies.
3. Optionally setup your editor/IDE following the official documentation.

Submitting a Pull Request (PR)

Before you submit your Pull Request (PR) consider the following guidelines:

• Search GitHub for an open or closed PR that relates to your submission. You don't want to duplicate effort.
• Fork repository and make your changes in a new git branch:

  git checkout -b feature-branch main

• Make sure your changes are following the code style guidelines.
• Commit your changes.

  git commit -m "feat: add new feature"

• Push your changes to GitHUb:

  git push origin feature-branch

• Create your PR on GitHub pointing to gh-contribution-mate:main.

Code Style Guidelines

We follow Deno formatting and linting. You can automatically apply formatting rules with deno fmt, and lint with deno lint. We encourage you to setup your IDE/Editor to automatically apply formatting.

Release

To release a new version the RC (release coordinator) should:

1. Create a new release branch
2. Bump up the version in version.ts
3. Commit the changes, push the branch, and prepare a PR
4. Merge the PR to main
5. Pull the changes locally, create a new tag with the correct version and push it