Quick guide

• Fork the repo.
• Checkout the branch you want to make changes on:
• Develop branch in 95% of the cases.
• Install the dependencies: `composer install`.
• Create branch such as: `feature-foo` or `fix-bar`.
• Write some awesome code!
• Add some tests, and ensure your code is PSR-2 compliant.
• Submit your Pull Request

When opening a pull request

You can do some things to increase the chance that your pull request is accepted the first time:

• Submit one pull request per fix or feature.
• If your changes are not up to date - rebase your branch on the parent branch.
• Follow the conventions used in the project.
• Remember about tests and documentation.

Naming Conventions

• Use camelCase, not underscores, for variable, function and method names, arguments.
• Use namespaces for all classes.
• Prefix abstract classes with Abstract.
• Suffix interfaces with Interface.
• Suffix traits with Trait.
• Suffix exceptions with Exception.
• Suffix services with Service.
• Use alphanumeric characters and underscores for file names.

PHPDoc

We generally follow the doc standards of Laravel.

/**
 * Register a binding with the container.
 *
 * @param  string|array  $abstract
 * @param  \Closure|string|null  $concrete
 * @param  bool  $shared
 * @return void
 */
public function bind($abstract, $concrete = null, $shared = false)
{
    //
}

Other general standards we follow

• PSR-1: Basic Coding Standard
• PSR-2: Coding Style Guide
• PSR-4: Autoloading Standard
• Symfony Coding Standards

The MIT License (MIT)


Copyright (c) Grafite Inc.




Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:





The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.




THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.