Download the PHP package purplebooth/git-github-lint without Composer
On this page you can find all versions of the php package purplebooth/git-github-lint. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download purplebooth/git-github-lint
More information about purplebooth/git-github-lint
Files in purplebooth/git-github-lint
Package git-github-lint
Short Description Lint github commits and update their status
License MIT
Informations about the package git-github-lint
Git GitHub Lint
This project is designed to ensure that the commits you're making to a repository follow the git coding style. This is the library component with no web frontend.
The standard that they test for is the one described by Chris Beams.
The validations it implements are:
- Separate subject from body with a blank line
- Limit the subject line to 50 characters (soft limit, hard limit at 69)
- Capitalize the subject line
- Do not end the subject line with a period
- Wrap the body at 72 characters
Getting Started
Prerequisities
You'll need to install:
- PHP (Minimum 7.0)
Installing
Usage
Tool
You can try out this library by using it as a tool. You'll need to generate a token on the GitHub Personal Access Token Page.
Usage
Output While Running
You can look at the pull requests on this repo to see what the effect is like in person.
Library
You can use the whole library
Please depend on the interfaces rather than the concrete implementations. Concrete implementations may change without causing a BC break, interfaces changing will cause major version increment, indicating a BC break.
Running the tests
To run the tests for coding style
First checkout the library, then run
Coding Style
We follow PSR2, and also enforce PHPDocs on all functions
Unit tests
We use PHPSpec for unit tests
Contributing
Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.
Versioning
We use SemVer for versioning. For the versions available, see the tags on this repository.
Authors
See the list of contributors who participated in this project.
License
This project is licensed under the MIT License - see the LICENSE.md file for details
All versions of git-github-lint with dependencies
php Version ^7.0.0
php-http/guzzle6-adapter Version ^1.1
symfony/console Version ^3.1
purplebooth/git-lint-validators Version ^1.0