项目作者: adham90

项目描述 :
:rabbit2: A fully configurable git commit message linter CLI tool, based on https://conventionalcommits.org standards.
高级语言: Ruby
项目地址: git://github.com/adham90/commit-lint.git
创建时间: 2017-06-17T05:18:17Z
项目社区:https://github.com/adham90/commit-lint

开源协议:MIT License

下载


:rabbit2:CommitLint

A fully configurable git commit message linter CLI tool, based on https://conventionalcommits.org standards.

Installation

Add this line to your application’s Gemfile:

  1. gem 'commit_lint'

And then execute:

  1. $ bundle

Or install it yourself as:

  1. $ gem install commit_lint

Usage

Just type commit-lint in a Git project’s folder to start linting your last
commit,

  1. $ commit-lint

to run commit-lint against you current branch run

  1. $ commit-lint -b

or other branche,

  1. $ commit-lint -b other-branche-name

commits range

  1. $ commit-lint -c 2343..2342

and you can add -a flag to run autocorrect against failing commits

  1. $ commit-lint -a

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake spec to run the tests. You can also run bin/console for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and tags, and push the .gem file to rubygems.org.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/adham90/commit-lint. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.

License

The gem is available as open source under the terms of the MIT License.