# commitlint-config-seek

> Shareable commitlint config for SEEK

Latest version **1.0.0** (published 2018-01-04) · MIT license · 0 weekly downloads

## Install

```sh
npm install commitlint-config-seek
pnpm add commitlint-config-seek
yarn add commitlint-config-seek
bun add commitlint-config-seek
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.0 |
| Published | 2018-01-04 |
| First published | 2018-01-04 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 3 |
| Author | Seek |
| Maintainers | mjt01 |

## Links

- npm: https://www.npmjs.com/package/commitlint-config-seek
- Repository: https://github.com/seek-oss/commitlint-config-seek
- Homepage: https://github.com/seek-oss/commitlint-config-seek#readme
- Issues: https://github.com/seek-oss/commitlint-config-seek/issues
- npm.io page: https://npm.io/package/commitlint-config-seek

## Dependencies (1)

- [@commitlint/config-conventional](https://npm.io/package/@commitlint/config-conventional.md) ^5.2.3

## Recent versions

- 1.0.0 (latest) — 2018-01-04

## README

[![Build Status](https://img.shields.io/travis/seek-oss/commitlint-config-seek/master.svg?style=flat-square)](http://travis-ci.org/seek-oss/commitlint-config-seek) [![npm](https://img.shields.io/npm/v/commitlint-config-seek.svg?style=flat-square)](https://www.npmjs.com/package/commitlint-config-seek) [![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg?style=flat-square)](https://github.com/semantic-release/semantic-release) [![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg?style=flat-square)](http://commitizen.github.io/cz-cli/)


# commitlint-config-seek

Shareable [commitlint](https://github.com/marionebl/commitlint) configuration for [SEEK](https://github.com/seek-oss).

This configuration uses the [conventional](https://github.com/marionebl/commitlint/tree/master/@commitlint/config-conventional) commit format, with a couple of exceptions:
- Scopes are case insensitive (rather than lower case), most notably to support React components, e.g. `fix(Button): ...`
- Subjects are sentence case (rather than lower case), because it (arguably) improves readability.

## Usage
You can set this up [a few different ways](https://github.com/marionebl/commitlint#config), easiest is probably just adding it into your `package.json` like so:

```js
{
  "commitlint": {
    "extends": "commitlint-config-seek"
  }
}
```

## License

MIT.

---
_Source: https://npm.io/package/commitlint-config-seek · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._