Skip to content

Commit

Permalink
docs(contributing): add basic introductory text before the TOC
Browse files Browse the repository at this point in the history
  • Loading branch information
myii committed Feb 23, 2019
1 parent 5f2d789 commit 45ccaf6
Showing 1 changed file with 5 additions and 2 deletions.
7 changes: 5 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
# How to contribute

This document will eventually outline all aspects of guidance to make your contributing experience a fruitful and enjoyable one.
What it already contains is information about _commit message formatting_ and how that directly affects the numerous automated processes that are used for this repo.

<table><tr><th>Table of Contents</th></tr><tr><td>
<!-- toc -->
<!-- tocstop -->
Expand All @@ -9,7 +12,7 @@

### Automation of multiple processes

This repo uses [`semantic-release`](https://github.com/semantic-release/semantic-release) for automating numerous processes such as bumping the version number appropriately, creating new tags/releases and updating the changelog.
This formula uses [`semantic-release`](https://github.com/semantic-release/semantic-release) for automating numerous processes such as bumping the version number appropriately, creating new tags/releases and updating the changelog.
The entire process relies on the structure of commit messages to determine the version bump, which is then used for the rest of the automation.

Full details are available in the upstream docs regarding the [Angular Commit Message Conventions](https://github.com/angular/angular.js/blob/master/DEVELOPERS.md#-git-commit-guidelines).
Expand All @@ -34,7 +37,7 @@ So based on the example above:

### Linting commit messages in Travis CI

This repo uses [`commitlint`](https://github.com/conventional-changelog/commitlint) for checking commit messages during CI testing.
This formula uses [`commitlint`](https://github.com/conventional-changelog/commitlint) for checking commit messages during CI testing.
This ensures that they are in accordance with the `semantic-release` settings.

For more details about the default settings, refer back to the `commitlint` [reference rules](https://conventional-changelog.github.io/commitlint/#/reference-rules).
Expand Down

0 comments on commit 45ccaf6

Please sign in to comment.