How to contribute

Contributing to AsgardCMS is fairly straitforward. The easiest way is listed below.

Please note AsgardCMS follows PSR-1 and PSR-2. Please make sure your code follows those standards.

You can use a great tool : PHP-CS-Fixer to make sure everything is following the correct coding style.

Every module has a .php_cs config file to run php-cs-fixer with:

$ cd Modules/{ModuleName}
$ php-cs-fixer fix . --config-file=".php_cs" --verbose

Please run php-cs-fixer before sending a pull request

You can also make a git hook to have php-cs-fixer run before every push. In your .git/hooks folder add a pre-push file with the following:

#!/bin/sh

exec php-cs-fixer fix . --config-file=".php_cs"
exec git commit -am 'PSR-2'

The next time you'll push something, php-cs-fixer file automatically run.

Getting setup

This is the same as modules except cd-ing into the Themes/ folder and cloning desired themes in there.

Once you have your copy of AsgardCMS installed and configured for contributing purposes, you're ready to make changes.

AsgardCMS follows a workflow similar to Git Flow branching model.

This means: