Skip to content

Commit 45ccaf6

Browse files
committed
docs(contributing): add basic introductory text before the TOC
1 parent 5f2d789 commit 45ccaf6

File tree

1 file changed

+5
-2
lines changed

1 file changed

+5
-2
lines changed

CONTRIBUTING.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,8 @@
11
# How to contribute
22

3+
This document will eventually outline all aspects of guidance to make your contributing experience a fruitful and enjoyable one.
4+
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.
5+
36
<table><tr><th>Table of Contents</th></tr><tr><td>
47
<!-- toc -->
58
<!-- tocstop -->
@@ -9,7 +12,7 @@
912

1013
### Automation of multiple processes
1114

12-
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.
15+
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.
1316
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.
1417

1518
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).
@@ -34,7 +37,7 @@ So based on the example above:
3437

3538
### Linting commit messages in Travis CI
3639

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

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

0 commit comments

Comments
 (0)