NAME

App::GitHooks::Plugin - Base class for plugins.

VERSION

Version 1.4.0

METHODS

get_file_check_description()

Return a description of the check performed on files by the plugin and that will be displayed to the user, if applicable, along with an indication of the success or failure of the plugin.

my $description = $plugin_class->get_file_check_description();

get_name()

Return the name of the plugin. For example, for App::GitHooks::Plugin::Test, the name will be Test.

my $name = $plugin->get_name();

BUGS

Please report any bugs or feature requests through the web interface at https://github.com/guillaumeaubert/App-GitHooks/issues/new. I will be notified, and then you'll automatically be notified of progress on your bug as I make changes.

SUPPORT

You can find documentation for this module with the perldoc command.

perldoc App::GitHooks::Plugin

You can also look for information at:

• GitHub's request tracker

  https://github.com/guillaumeaubert/App-GitHooks/issues

• AnnoCPAN: Annotated CPAN documentation

  http://annocpan.org/dist/app-githooks

• CPAN Ratings

  http://cpanratings.perl.org/d/app-githooks

• MetaCPAN

  https://metacpan.org/release/App-GitHooks

AUTHOR

Guillaume Aubert, <aubertg at cpan.org>.

COPYRIGHT & LICENSE

Copyright 2013-2015 Guillaume Aubert.

This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License version 3 as published by the Free Software Foundation.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program. If not, see http://www.gnu.org/licenses/