README.md

Todo Reminder

A command line script that reminds of unfinished TODO comments in changed PHP files after Git commit. Intended as post-commit Git hook.

Install

Via Composer in project

composer require integer-net/todo-reminder

Via Composer globally

composer global require integer-net/todo-reminder

Usage

To check the last commit of the current repository, run

vendor/bin/todo

If you installed Todo Reminder globally,

todo --root /path/to/repository

To run the checks automatically after each commit, create a hook as .git/hooks/post-commit with content like:

#!/bin/sh
exec vendor/bin/todo

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

chmod +x .git/hooks/post-commit

Change log

Please see CHANGELOG for more information on what has changed recently.

Testing

composer test

Runs unit tests, mutation tests and static analysis

Contributing

Please see CONTRIBUTING and CODE_OF_CONDUCT for details.

Security

If you discover any security related issues, please email [email protected] instead of using the issue tracker.

Credits

• Fabian Schmengler
• All Contributors

License

The MIT License (MIT). Please see License File for more information.