Contributor guidelines for Magallanes

Welcome to Magallanes! We are much appreciated you've decided to contribute this project! Please read the following guidelines to make your and our work easier and cleaner.

TL;DR

Write clean code with no mess left
Contribute the docs when adding configurable new feature
Push your code into develop branch
Ensure your code is fully covered by tests

Reporting issues

If you have a problem or you've noticed some bug, please feel free to open new issue. However please follow the rules below:

First, make sure that similar/the same issue doesn't already exist
If you've already found the solution of the problem you are about to report, plaase feel free to open new pull request. Then follow the rules below in Developing Magallanes section.
If you are able to, include some test cases or steps to reproduce the bug for us to examine the problem to reach the problem origin.

Opening pull requests

Pull Request are actually some kind of issues with code, so please keep the rules above in Reporting issues section before making the pull requests. Our code isn't so beautiful, tested and testable as we would like it to be but if you're pushing your code please be sure it meets the requirements from Organization and code quality chapter. We want to improve the existing code to facilitate extending it and making fixes quicker. So if you are editing some class and you find it ugly, please do not ignore it. Following The Boy Scout Rule - Leave the campground cleaner than you found it - we allcan improve the existing code.

Contributing the documentation

Magallanes is made to deploy application quick and with no need to write redudant code. Usage is as simple as writing the configuration for target project in YAML files. In the nearest future we would like to make some Wiki with all available options, tasks and commands. For now, the only "documentation" is examples file in doc directory. If the code you are going to include in your pull requests adds or changes config options, please make sure you that you create a new sample in that file. You should also to the same with commands.

Developing Magallanes

Branches

The flow is pretty simple. In most common cases we work on develop branch. It's a branch with the newest changes which sometimes need more testing. All pull requests are opened to be merged into that branch. That keeps us safe to not deploy unsafe code into production - master branch. When we decide that every changeset in develop is tested manually and works as it's intented, we merge it to master. If the change you commited is pretty hot and needs to be released ASAP, you are allowed to make a pull request to master branch. But it's the only case, please try to avoid it. All pull request that are not made on develop will be rejected. If you want to use develop branch in your code, simple pass dev-develop to dependency version in your composer.json file:

{
	"require": {
		"andres-montanez/magallanes": "dev-develop"
	}
}

Organization and code quality

We use PSR2 as PHP coding standard. Some of rules we follow that are not included in document above:

Variables' and properties' names are camelCased (e.g.: $thisIsMyVariable)
Avoid too long or too short variables' and methods' names, like $thisIsMyAwesomeVariableAndImProudOfIt
Names of your properties/method should be intuitive and self-describing - that means your code should look like a book. Developer who reads the code should immediately know what the variable includes or what the method does.
Let your methods will be verbs. For boolean methods, prefix it with is, has, and so on. E.g.: isConfigurable, hasChildren.
Be SOLID and follow KISS - let the class be responsible only for its tasks.
Write testable code and if there's a need - easy extendible.
Avoid duplications

The rules above have been set a long time after the project has started. If you notice some violations, plase open new issue or even pull request with fixes, we'll be much appreciated.

Tools you can use to ensure your code quality

PHP-CodeSniffer
PHP Mess Detector
PHP Copy/Paste Detector
PHP Dead Code Detector

Testing and quality

We use PHPUnit to test our classes. Now not the whole project is covered with tests but we've been working on it for some time. If you want your code to be merged into Magallanes, we want you to push it with proper tests. We would love to reach and keep at leats 90% of code coverage. In short time we want to configure quality tools to make sure your code is tested properly with minimum coverage. Anyway, try to keep 100% of Code Coverage in your pull requests. Tests structure follow the same structure as production code with Test suffix in class and file name. All tests should go to tests directory in project root. So if you've created a class Mage\Tasks\BuilIn\NewTask the testing class should be called MageTest\Tasks\BuiltIn\NewTaskTest.

Configuration

Magallanes configuration is kept in YAML files. Please follow those rules while adding or changing the configuration:

Keep 2 spaces indentation in each level
Multi-word config keys should be joined with dash (-), like my-custom-task
If your contribution includes new config key, please be sure that you've documented it in configuration documentation.

5.6 KiB Raw Blame History