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

Shareable commitlint config used by Hadenlabs 🚀
https://github.com/hadenlabs/commitlint-config

commitlint commitlint-config git hadenlabs lint peru

Last synced: 23 days ago
JSON representation

Shareable commitlint config used by Hadenlabs 🚀

• Host: GitHub
• URL: https://github.com/hadenlabs/commitlint-config
• Owner: hadenlabs
• License: lgpl-3.0
• Created: 2021-03-17T03:25:47.000Z (almost 4 years ago)
• Default Branch: develop
• Last Pushed: 2022-12-01T17:12:03.000Z (about 2 years ago)
• Last Synced: 2024-11-10T19:42:26.303Z (about 2 months ago)
• Topics: commitlint, commitlint-config, git, hadenlabs, lint, peru
• Language: Makefile
• Homepage:
• Size: 245 KB
• Stars: 1
• Watchers: 2
• Forks: 1
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: docs/contributing.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE
  • Code of conduct: docs/code_of_conduct.md

Awesome Lists containing this project

README

        


# commitlint-config

[![GitHub tag (latest SemVer)](https://img.shields.io/github/v/tag/hadenlabs/commitlint-config.svg?label=latest&sort=semver)](https://github.com/hadenlabs/commitlint-config/releases) [![Lint](https://github.com/hadenlabs/commitlint-config/actions/workflows/lint.yml/badge.svg?branch=develop)](https://github.com/hadenlabs/commitlint-config/actions) [![Issues](https://img.shields.io/github/issues/hadenlabs/commitlint-config.svg)](https://github.com/hadenlabs/commitlint-config/issues) [![Latest Release](https://img.shields.io/github/release/hadenlabs/commitlint-config.svg)](https://github.com/hadenlabs/commitlint-config/releases)

Commitlint configuration

## Installation

### [yarn](https://yarnpkg.com)

If you're using [yarn](https://yarnpkg.com)

```shell

  yarn add --dev husky @commitlint/cli @commitlint/config-conventional @hadenlabs/commitlint-config

```

### [npm](https://www.npmjs.com)

If you're using [npm](https://www.npmjs.com)

```shell

  npm i --save-dev husky @commitlint/cli @commitlint/config-conventional @hadenlabs/commitlint-config

```

## Usage

Create file `.commitlintrc.json` with extending preset and define set of scopes:

```json

{

  "extends": ["@hadenlabs/config-conventional"],

  "rules": {

    "type-enum": [

      2,

      "always",

      [

        // as examples

        "app",

        "common"

      ]

    ]

  }

}

```

Add to `package.json` next section:

```json

{

  "husky": {

    "hooks": {

      "commit-msg": "commitlint -E HUSKY_GIT_PARAMS"

    }

  }

}

```

## Help

**Got a question?**

File a GitHub [issue](https://github.com/hadenlabs/commitlint-config/issues).

## Contributing

### Bug Reports & Feature Requests

Please use the [issue tracker](https://github.com/hadenlabs/commitlint-config/issues) to report any bugs or file feature requests.

### Development

In general, PRs are welcome. We follow the typical "fork-and-pull" Git workflow.

1.  **Fork** the repo on GitHub

2.  **Clone** the project to your own machine

3.  **Commit** changes to your own branch

4.  **Push** your work back up to your fork

5.  Submit a **Pull Request** so that we can review your changes

**NOTE:** Be sure to rebase the latest changes from "upstream" before making a pull request!

## Module Versioning

This Module follows the principles of [Semantic Versioning (SemVer)](https://semver.org/).

Using the given version number of `MAJOR.MINOR.PATCH`, we apply the following constructs:

1. Use the `MAJOR` version for incompatible changes.

1. Use the `MINOR` version when adding functionality in a backwards compatible manner.

1. Use the `PATCH` version when introducing backwards compatible bug fixes.

### Backwards compatibility in `0.0.z` and `0.y.z` version

- In the context of initial development, backwards compatibility in versions `0.0.z` is **not guaranteed** when `z` is increased. (Initial development)

- In the context of pre-release, backwards compatibility in versions `0.y.z` is **not guaranteed** when `y` is increased. (Pre-release)

## Copyright

Copyright © 2018-2021 [Hadenlabs](https://hadenlabs.com)

## Trademarks

All other trademarks referenced herein are the property of their respective owners.

## License

The code and styles are licensed under the LGPL-3.0 license [See project license.](LICENSE).

## Don't forget to 🌟 Star 🌟 the repo if you like commitlint-config

[Your feedback is appreciated](https://github.com/hadenlabs/commitlint-config/issues)