sunnysideup/modulechecks

Checks the basic health of your silverstripe modules

0.4.1 2018-05-14 05:18 UTC

Requires

• friendsofphp/php-cs-fixer: ^1.12
• silverstripe/cms: ~3.6
• silverstripe/framework: ~3.6
• symfony/yaml: ^3.1

BSD-3-Clause

• Nicolaas Francken

• composer
• cms
• modules
• automation
• silverstripe
• license
• packagist
• addons
• quality control
• Silverstripe-CMS

README

Documentation

• Developer Docs
• User Guide
• API Docs

Requirements

See composer.json for details

Suggested Modules

See composer.json for details

Installation

composer require sunnysideup/modulechecks

Configuration

In the _config folder you will find the modulechecks.yml.example file that shows options for the configuration of this module.

We recommend that you:

1. copy these modulechecks.yml.example files into your app/_config folder (where available - otherwise search for private static $ in the module to see what can be configured)
2. remove the .example extension,
3. delete the lines you do not care about, and
4. adjust the configurations that you would like to use.

Contributing

We welcome any contributions. See CONTRIBUTING.md for more details.

Paid assistance

You can pay us to create an improved / adapted version of this module for your own projects. Please contact us if you like to find out more: www.sunnysideup.co.nz. For exmaple, we can write tests for this module.

Author

Sunny Side Up Ltd.

Care to see more modules?

To find other modules, please visit ssmods.com.