integer-net/todo-reminder

GrumPHP Extension to remind you of undone todos

Todo Reminder

![Software License][ico-license] ![Coverage Status][ico-scrutinizer] ![Total Downloads][ico-downloads], _(*1)

A command line script that reminds of unfinished TODO comments in changed PHP files after Git commit. Intended as post-commit Git hook., _(*2)

Install

Via Composer in project, _(*3)

``` bash composer require integer-net/todo-reminder, <sub>(*4)</sub>

Via Composer globally

``` bash
composer global require integer-net/todo-reminder

Usage

To check the last commit of the current repository, run ``` bash vendor/bin/todo, <sub>(*5)</sub>

If you installed Todo Reminder globally,

``` bash
todo --root /path/to/repository

To run the checks automatically after each commit, create a hook as .git/hooks/post-commit with content like:, <sub>(*6)</sub>

``` bash, <sub>(*7)</sub>

!/bin/sh

exec vendor/bin/todo, <sub>(*8)</sub>

Make the hook executable, so that Git can run it:

chmod +x .git/hooks/post-commit, <sub>(*9)</sub>

## Change log

Please see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently.

## Testing

``` bash
composer test

Runs unit tests, mutation tests and static analysis, <sub>(*10)</sub>

Contributing

Please see CONTRIBUTING and CODE_OF_CONDUCT for details., <sub>(*11)</sub>

Security

If you discover any security related issues, please email fs@integer-net.de instead of using the issue tracker., <sub>(*12)</sub>

Credits

• Fabian Schmengler
• All Contributors

License

The MIT License (MIT). Please see License File for more information., <sub>(*13)</sub>