Cachet/CONTRIBUTING.md
2014-11-27 22:01:47 +00:00

1012 B

Contribution Guidelines

## Creating issues

It's dead simple, use the issue tracker. Be descriptive, remember this is a community and we're all helping each other, so be respectful towards each other.

Coding Standards

Please follow existing coding standards:

<?php

namespace Foo\Bar\Controller;

use Foo\Bar\Bar;

class Foo extends Bar {
    public function baz() {
        if ($condition) {
        }
    }
}

  • Atleast one newline seperating namespace, use, and class declarations
  • Spaces around operators and control blocks:
    if ($condition) {
    
    }
    
  • Braces on the same line. The exception to this rule is for long conditions.
  • Line lengths have a soft 80 limit and hard 120 length.
  • PHP constants should be in lowercase; true, false and null.
  • Defined constants should always be in uppercase.
  • Never leave trailing spaces at the end of a line.
  • Files should end with one blank line.

If you're still unsure, then take a look at existing code.