Skip to content

Latest commit

 

History

History
47 lines (34 loc) · 1.29 KB

CONTRIBUTING.md

File metadata and controls

47 lines (34 loc) · 1.29 KB

Contributing Guidelines

Commit message style

Format

Follow the style of conventional commits:

<type>[optional scope][optional bang]: <short description>

<optional body>

<optional footer>

where [optional scope] should be enclosed by parentheses, e.g., (readme), and [optional bang] should be ! if any, indicating that the commit contains breaking changes.

Types

  • fix: Fix a bug.
  • feat: Introduce a new feature.
  • refactor: Change codes but do neither fix any bug nor introduce new features.
  • style: Just format codes. Small refactoring (e.g., changing a variable name) could be included, though.
  • test: Add, fix, change, or refactor test codes.
  • docs: Add, fix, change, or improve writing of documentation.
  • ci: Add, fix, change, or refactor CI stuff (e.g, GitHub workflows).
  • tools: Add, fix, change, or refactor development tools (e.g, formatters).
  • release: Bump version of this repository itself. Any Git tag should be attached to these commits.

Scopes

  • readme: README.md.
  • changelog: CHANGELOG.md
  • contributing: CONTRIBUTING.md
  • nix: flake.nix or flake.lock
  • deps: Node or Spago dependencies.