https://github.com/socifi/commitlint-config

Shareable config for linting commit messages.
https://github.com/socifi/commitlint-config

commitlint commitlint-config

Last synced: 2 days ago
JSON representation

Shareable config for linting commit messages.

• Host: GitHub
• URL: https://github.com/socifi/commitlint-config
• Owner: socifi
• License: apache-2.0
• Created: 2018-04-18T12:57:22.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2023-01-09T22:28:15.000Z (almost 2 years ago)
• Last Synced: 2024-11-01T17:09:55.097Z (7 days ago)
• Topics: commitlint, commitlint-config
• Language: JavaScript
• Size: 1.86 MB
• Stars: 0
• Watchers: 3
• Forks: 0
• Open Issues: 16
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Commitlint Config

[![npm version](https://badge.fury.io/js/%40socifi%2Fcommitlint-config.svg)](https://badge.fury.io/js/%40socifi%2Fcommitlint-config)

[![CircleCI](https://circleci.com/gh/socifi/commitlint-config/tree/master.svg?style=shield)](https://circleci.com/gh/socifi/commitlint-config/tree/master)

Shareable config for [commitling](https://github.com/marionebl/commitlint).

## How to use

Create ```commitlint.config.js``` file and enter following config:

```javascript

module.exports = {

    extends: ['@socifi/commitlint-config'],

};

```

## Format of Commit message

```Changed: CON-865 Some change in code.```

### Type

Following types are allowed:

- **Changed**

- **Fixed**

- **Removed**

- **Added**

- **Depreciated**

- **Docs**

- **Refactored**

- **Test** - should not be in master branch

- **InProgress, WIP** - should not be in master branch

### Reference

Reference to JIRA issue. eg. CON-156. It is recommended but not required.

### Commit message

MUST exist.