Skip to content

Latest commit

 

History

History
21 lines (13 loc) · 1.42 KB

CONTRIBUTING.md

File metadata and controls

21 lines (13 loc) · 1.42 KB
Raw

Contributing to Gris-Gris Skelton

All contributions are welcome to be submitted for review for inclusion , but before they will be accepted, we ask that you follow these simple steps:

1. Submitted code must follow the Code Standards.

2. Submitted code must not cause existing unit tests to fail.

  • If a change in a method causes a change in the expected behavior, the unit test should also be updated to match the change.

3. Unit tests are strongly encouraged for all pull requests.

  • Gris-Gris Skelton uses PHPUnit for its unit testing. Please review the PHPUnit manual at http://www.phpunit.de/manual/current/en/index.html.
  • Whether your pull request is a bug fix or introduces new classes or methods, we ask that you include unit tests for your changes.
  • Although bug fixes may be accepted without unit tests (so long as existing tests do not fail with your change), new classes will not be accepted without tests to validate its functionality.

4. Documentation is strongly encouraged.

  • The Gris-Gris Skelton Manual is contained in the docs directory of this repo and is written in Markdown format.
  • When submitting new packages, documentation will be required with your pull request. Please use the existing documentation for examples.
  • We understand that not all code is documented at this time. Feel free to expand on the existing documentation by adding to existing chapters or submitting new chapters.