derickr / clearPHP

Reference for writing clear PHP code

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

clearPHP

Reference for writing clear PHP code

It is difficult to know when one's code is well written. There are recommandations for writting PHP code in the manual, from CS theories, peers review and gut feeling. That makes a lot of rules.

The main goal of this document is to collect such rules, so as to have them all easy to review and select them for reviewing one's code. This aims at being a reference document, in which anyone may look for ways to improve his code.

There is no purpose to make this any kind of law, compelling system or reward target. Use it if you find it useful and ignore the rest.

Proposing a New Rule

To propose a new rule :

  • fork this repo, create a branch, checkout that branch, add the rule in proposition branch, push the branch to Github, and send a pull request
  • Join us on the mailing-list

About

Reference for writing clear PHP code

License:Other