Download the PHP package anroots/pgca without Composer
On this page you can find all versions of the php package anroots/pgca. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Package pgca
Short Description Analyzes Git commit messages for poor committing practices and reports a list of violations
License MIT
Homepage https://github.com/anroots/pgca
FAQ
Example:
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
- Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
- To use Composer is sometimes complicated. Especially for beginners.
- Composer needs much resources. Sometimes they are not available on a simple webspace.
- If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
- Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Informations about the package pgca
PHP Git Commit Analyser
A CLI tool which analyses Git commits for violations.
This project aims to improve the quality of your commit practices by applying a set of rules against your commit (message) and then yelling at you when you get too lazy.
The project was born from frustration of seeing commit messages like "fix some stuff" and people's inability to write good commit messages.
Development status: Alpha, ongoing. Unstable public API. Is usable.
Install
-
Include via Composer:
- Copy
config/pgca.ymlinto your project root - Customize the contents of
pgca.yml
Usage
To analyze the commit history of the current project, run the analyzer from the command line:
You can customize the analysis in the pgca.yml file and with CLI options.
Print the "simple" report in table format to the console and analyse the last 40 Git commits of the current branch:
Documentation
See the wiki for more documentation.
Requirements
- PHP >= 5.6
- Composer
Rules
See the wiki for documentation about standard rules. For a full list of available rules, run vendor/bin/pgca/rules:list:
Testing
Contributing
Please see CONTRIBUTING for details.
Backlog
These are the broader topics that need improvement and are planned in the undefined near future:
Rule implementations
- [message] summary is in present / imperative form
- [message] has ticket reference in commit message
- [message] is in English
- [content] commit does not contain excessive changed file count (commits that change 100 files)
Refactoring
- Add more in-code documentation
- Increase unit test coverage
- Refactor code, from alpha version to 1.0 quality
- Improve HTML report
- Add longer 'explanation' block to all rules. Might be 2-3 paragraphs with examples and a long explanation why this particular rule exists
Credits
- Ando Roots
- All Contributors
License
The MIT License (MIT). Please see License File for more information.
All versions of pgca with dependencies
symfony/console Version ~2.6
symfony/dependency-injection Version ~2.6
symfony/config Version ~2.6
dflydev/dot-access-data Version ~1.0
gitonomy/gitlib Version ~0.1.7
swearjar/swearjar Version ~0.1
mustache/mustache Version ~2.8