Skip to content

Latest commit

 

History

History
81 lines (52 loc) · 2.75 KB

CONTRIBUTING.md

File metadata and controls

81 lines (52 loc) · 2.75 KB
Raw

Contributing to halfpipe

If you would like to contribute to halfpipe, fork this repo and submit a pull request. Please make sure the feature/fix you are submitting is/was not done by any other developer already.

Commits

Each feature 'should' be squashed into a single commit as to avoid polluting commit history. Major change commits can remain un-squashed. Use your best judgement.

Commit Message Format

Each commit message consists of a header, a body and a footer. The header has a special format that includes a type, a scope and a subject:

<type>(<scope>): <subject>
<BLANK LINE>
<body>
<BLANK LINE>
<footer>

The header is mandatory and the scope of the header is optional.

Any line of the commit message cannot be longer 100 characters! This allows the message to be easier to read on GitHub as well as in various git tools.

Revert

If the commit reverts a previous commit, it should begin with revert:, followed by the header of the reverted commit. In the body it should say: This reverts commit <hash>., where the hash is the SHA of the commit being reverted.

Type

Must be one of the following:

  • feat: A new feature
  • fix: A bug fix
  • docs: Documentation only changes
  • style: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)
  • refactor: A code change that neither fixes a bug nor adds a feature
  • perf: A code change that improves performance
  • test: Adding missing tests
  • chore: Changes to the build process or auxiliary tools and libraries such as documentation generation

Scope

The scope could be anything specifying place of the commit change.

Subject

The subject contains succinct description of the change:

  • use the imperative, present tense: "change" not "changed" nor "changes"
  • don't capitalize first letter
  • no dot (.) at the end

Body

Just as in the subject, use the imperative, present tense: "change" not "changed" nor "changes". The body should include the motivation for the change and contrast this with previous behavior.

Footer

The footer should contain any information about Breaking Changes and is also the place to reference GitHub issues that this commit Closes.

Breaking Changes should start with the word BREAKING CHANGE: with a space or two newlines. The rest of the commit message is then used for this.

Dependencies

npm install will install all dependencies.

Tests

All PRs should be accompanied by unit tests. Your feature branch must pass a CI build before it can be merged in. Tests can be run locally by running npm test.

Release

Verify that the feature is going into the correct release branch. The master branch is the latest 'edge' version.