Skip to content

added RFC 2119 information, changed wording #10

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jan 2, 2019
Merged

added RFC 2119 information, changed wording #10

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 11 additions & 8 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,18 +4,21 @@
This repository contains the ruleset for the PHP code we develop at [FLYERALARM](https://flyeralarm.com).
It mostly consists of PSR-2 with some custom additions. The rules are enforced with the help of squizlabs/PHP_CodeSniffer

The key words “MUST”, “MUST NOT”, “REQUIRED”, “SHALL”, “SHALL NOT”, “SHOULD”,
“SHOULD NOT”, “RECOMMENDED”, “MAY”, and “OPTIONAL” in this document are to be
interpreted as described in [RFC 2119](http://www.ietf.org/rfc/rfc2119.txt).

## Custom Rules in addition to PSR-2

* Variable names must be in lowerCamelCase
* Yoda conditions are forbidden
* Unit tests with @expectedException must contain @expectedExceptionMessage annotation
* Return type annotations (@return) must only contain one of scalar type, object (e.g. no "@return string|null") or
* Variable names MUST be in lowerCamelCase
* Yoda conditions MUST NOT be used
* Unit tests with @expectedException MUST contain @expectedExceptionMessage annotation
* Return type annotations (@return) MUST only contain one of scalar type, object (e.g. no "@return string|null") or
an array of one these
* Exceptions messages must not contain exclamation marks or full stops
* Keywords GOTO and EVAL are forbidden
* Underscores in namespaces are forbidden
* Classtype suffixes like Interface, Abstract or Trait are forbidden (e.g. LoggerInterface)
* Exceptions messages MUST not contain exclamation marks or full stops
* Keywords GOTO and EVAL MUST NOT be used
* Underscores in namespaces MUST NOT be used
* Classtype suffixes like Interface, Abstract or Trait MUST NOT be used (e.g. LoggerInterface)


## How-To work within *this* project
Expand Down