contributing.md

Contributing

This package is always open to contributions:

• Master will always contain the newest work (bug fixes, new features, etc), however it may not always be stable; use at your own risk. Every new tagged release will come from the work done on master, once things have stablized, etc.

Formating

I'm very particular about the way I format my php code. In general, if you're submitting a pull request to Stapler, please adhere to the following guidelines and conventions:

If statements should always be wrapped in curly braces and contain a single space on both sides the parens. If there is only a single line of code to be executed, please put the first curly brace on the same line as the condition:

if (true) {
	$foo = $bar;
}

If there is more than one statement to be executed, each curly brace should appear on its own line:

if (true) 
{
	$foo = $bar;
	$baz = $qux;
}

This formatting also applies to loops:

foreach ($foo as $bar) {
	$baz = $qux;
}

foreach ($foo as $bar)
{
	$baz = $qux;
	$quux = $corge;
}

File and class names should always be camel cased. Namespace and class declarations should always look like the following:

<?php namespace Codesleeve\Stapler\Foo\Bar;


class Baz
{

}

?>

Functions should always include docblock headers with each curly brace on a new line:

/**
 * A brief description of what the foo function does.
 *
 * @param string $name
 * @param array $baz
 */
function foo ($bar, array $baz) 
{
	//code
}

If a function has a return value, its type should also be listed in the docblock (the @return annotation should be omitted if there is no return value):

/**
 * A brief description of what the foo function does.
 *
 * @param string $name
 * @param array $baz
 * @return array
 */
function foo ($bar, array $baz) 
{
	return $baz;
}

Variables should always be named using camelback syntax and should be expressive of the data they contain:

$firstName = 'Travis';
$lastName = 'Bennett';