Skip to content

Latest commit

 

History

History
16 lines (13 loc) · 787 Bytes

CONTRIBUTING.md

File metadata and controls

16 lines (13 loc) · 787 Bytes

(this is a work in progress)

  1. Code formatting MUST follow PSR-2.
  2. Issues SHOULD include code and/or data to reproduce the issue.
  3. PR's for issues SHOULD include test(s) for issue.
  4. PR's SHOULD have adequate documentation (commit messages, comments, etc.) to readily convey what and/or why.
  5. Code SHOULD attempt to follow Object Calisthenics methodology.

Exceptions

  1. All exceptions thrown MUST implement CrEOF\Geo\Obj\Exception\ExceptionInterface.
  2. All thrown exception messages MUST end with a period "."
  3. Without a compelling reason new exception classes SHOULD have a use scope outside a single class.

Naming

  1. Acronyms in names SHOULD be all uppercase.
  2. Array keys MUST be all lowercase.