Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
87 lines (58 loc) · 2.59 KB

CONTRIBUTING.md

File metadata and controls

87 lines (58 loc) · 2.59 KB
Raw

Contributing Guide

Table of Contents

1. Installation

Start by running the following command:

make install

This will install all required dependencies and set up the git hooks.

Back to top ^

2. Commit Messages

Commit messages lean heavily towards the convention set out by conventional commits.

Each commit message must be in the format that includes a type, an optional scope and a subject:

type(scope?): subject  #scope is optional

Limit the whole message to 72 characters or less!

Example:

build(terraform): burn it all down

Back to top ^

2.1. Type

Must be one of the following:

  • build: Changes that affect the build system or external dependencies (example scopes: npm)
  • chore: Changes that don't really fall under any other type
  • ci: Changes to the CI configuration files and scripts
  • docs: Documentation only changes
  • feat: A new feature
  • fix: A bug fix
  • perf: A code change that improves performance
  • refactor: A code change that neither fixes a bug nor adds a feature
  • revert: Revert a previous commit
  • test: Adding missing tests or correcting existing tests

Back to top ^

2.2. Scope

A scope may be provided to a commit’s type, to provide additional contextual information and is contained within a parenthesis.

Back to top ^

2.3. Subject

The subject contains a succinct description of the change:

  • use the present tense ("Add feature" not "Added feature").
  • use the imperative mood ("Move cursor to..." not "Moves cursor to...").
  • don't capitalize the first letter.
  • don't use a fullstop (.) at the end. <- Not this

Back to top ^

3. Pull Requests

  1. Create a branch from the main branch and use the convention: <feat|fix|build>/name-of-issue.
  2. Once the code is ready to be merged into main, open a pull request.

⚠️ NOTE: The title must conform to the conventional commit message format outlined above.

  1. To merge the PR, use the "Squash and merge" option. This is to keep the commit history clean and keep the commits on main with a 1:1 ratio with previous PRs.

Back to top ^