Skip to content

Latest commit

 

History

History
63 lines (37 loc) · 1.8 KB

CONTRIBUTING.md

File metadata and controls

63 lines (37 loc) · 1.8 KB
Raw

Contributing to koa-playground

When contributing to this repository, please first discuss the change you wish to make via issue, email, or any other method with the owners of this repository before making a change.

Please note we have a code of conduct, please follow it in all your interactions with the project.

Table of Contents

Commit Message Guidelines

We have rules over how our git commit messages can be formatted. This leads to more readable messages that are easy to follow when looking through the project history. But also, we use the git commit messages to generate the change log. We follow conventional commits.

Commit Message Structure

<type>: <description>

[optional body]

[optional footer]

Samples

Commit message with no body
docs: correct spelling of CHANGELOG
Commit message with body and (optional) issue number
fix: minor typos in code

see the issue for details on the typos fixed

fixes issue #12

Type

  • build: Changes that affect the build system or external dependencies (example scopes: gulp, broccoli, npm)
  • chore: Extra works
  • ci: Changes to our CI configuration files and scripts (example scopes: Travis, Circle, BrowserStack, SauceLabs)
  • 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 some updates
  • style: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)
  • test: Adding missing tests or correcting existing tests

See more details about conventional commits.