Getting Started
composer install
./travis.sh
./vendor/bin/phpunit
Which branch should I make my PR form and send it to?
2.0
) if you're sending something for version 2.0,master
branch.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.
$ # in your Platform root directory
$ php-cs-fixer fix --verbose
To avoid having to type this every time, I have this command aliased to pcf
, like so:
pcf="php-cs-fixer fix --verbose"
Now I can type pcf
in the root directory of the module, and it'll just work, giving that there's a .php_cs
file.
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:
master
branch,feature/your-new-feature-name
,master
branch of the module/theme your modifying.master
branch,hotfix/your-hotfix-name
,master
branch of the module/theme your modifying.Adding new translations or updating existing translations to core modules is very easy in AsgardCms. All translations are centralised in the Translation module.
All you need to do is fork that module, and add and/or update existing translations.
The translations are located in the Resources/lang
folder, each module has its own subfolder, with under that the different locales.
If you want to add a new language, duplicate the en
folder of each module and renaming it to your desired locale. The English translations will usually the more complete ones, that's why it's best to use those as a starting point.