CONTRIBUTING.md

Contributing

First of all, thank you for considering contributing. Go team!

Here are a few rules I'd like you to follow when contributing (because I try to):

• Follow PHP Standards Recommendations (PSR)
  • PSR-1, Basic coding standard
  • PSR-2, Coding style guide
• Document your code using PHPDocumentor's syntax
  • Methods should start with a DocBlock.
  • A method's DocBlock should include a summary and a description, if a description is necessary.
  • A method's DocBlock should include, in order, the @since, @param, @return, @throws, and @see tags (if the @see is necessary necessary).
• Write unit tests using PHPUnit.
  • Tests should test behavior, not a million return types to find bugs (like I used to do). In other words, test inputs and outputs in different scenarios to make sure the function fulfills its promise to the rest of the code.
  • Tests should be named test<methodName>_returns<Value>_if<testCase> (e.g., testCopy_returnsTrue_ifSourceIsEmpty) or test<methodName>_throws<exceptionName>_if<testCase> (e.g., testCopy_throwsInvalidArgumentException_ifSourceDoesNotExist).
  • Tests should include only one assertion (although, of course, there are exceptions to this rule).

If those rules are palatable, here are the steps to follow:

1. Fork
2. Clone
3. PHPUnit
4. Branch
5. PHPUnit
6. Code
7. PHPUnit
8. Commit
9. Push
10. Pull request
11. Relax and eat a Paleo muffin

That's it! Looking forward to your pull request. If you have any questions, email me at [email protected]. Thanks.