https://github.com/projectcleverweb/peers
PHP Easy Efficiency & Readability Standards (PEERS)
https://github.com/projectcleverweb/peers
Last synced: 12 months ago
JSON representation
PHP Easy Efficiency & Readability Standards (PEERS)
- Host: GitHub
- URL: https://github.com/projectcleverweb/peers
- Owner: ProjectCleverWeb
- License: other
- Created: 2014-03-24T15:58:03.000Z (almost 12 years ago)
- Default Branch: master
- Last Pushed: 2014-09-06T04:40:48.000Z (over 11 years ago)
- Last Synced: 2025-01-15T08:03:34.888Z (about 1 year ago)
- Size: 195 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# PEER Standards [](https://raw.githubusercontent.com/ProjectCleverWeb/PEERS/master/LICENSE)
aka *"PHP Easy Efficiency & Readability Standards"*
These are quick-apply coding standards, based around the fundamentals of
keeping everything easy to read for everyone while not wasting time trying to
explain how to handle every edge case scenario.
**Status:** *[In Develpment](https://github.com/ProjectCleverWeb/PEERS/commits/master)*
Copyright © 2014 Nicholas Jordon - All Rights Reserved
## Overview
Each standard serves a logical purpose and is modular, meaning can you use
PEERS as a whole or pick-and-choose standards.
**There are 7 standards, They are as follows:**
- PEERS-0 Style Guide ([link](#))
- PEERS-1 Naming Conventions ([link](#))
- PEERS-2 Filesystem Conventions ([link](#))
- PEERS-3 Autoloading ([link](#))
- PEERS-4 Paradigms ([link](#))
- PEERS-5 Child Languages ([link](#))
- PEERS-6 Comments And Logging ([link](#))
## Getting Started
#### Learning The Standards
Standards are split into 2 parts, **The Summery** and **The Extended Documentation**.
Each standard has a summery file in its' directory. It is recommended that you
start with reading each of the summeries that apply to your project; and then
if you are not sure about a part (or parts) of a standard, read the extended
documentation files that apply to those parts of the standard.
This means, that you'll get the gist of the standard and be able start working
sooner. Then, when an edge case scenario comes into play, just check the
extended documentation.
#### Referencing Standards
If you're applying all of the PEER Standards, it is recommended that you
reference them with a link to this repository. **Like this:**
- This project uses [PEER Standards](https://github.com/ProjectCleverWeb/PEERS).
- This project uses [PEERS](https://github.com/ProjectCleverWeb/PEERS).
Alternatively, if you are only using specific standards, it is recommended that
you link the specific standards in use. **Like this:**
- This project uses PEER Standards [1](#), [3](#), and [5](#).
- This project uses [PEERS-1](#), [PEERS-3](#), and [PEERS-5](#).
- This project uses PEERS-[1](#)[3](#)[5](#).
#### Extended Documentation VS Summery
There is a carefully managed balance between what is allowed in the summery,
and what must only be in the extended documentation. In order to make the
extended documentation easier to navigate, each section of a standard is given
its' own file with its' sub-sections linked in the summery file.
This means that if you are reading the summery for a standard, and you are
confused about any section or sub-section, you can easily find a link to more
information on that section or sub-section.
## FAQs, Contributing, & Definitions
If you are curious about any of these topics please click the corrisponding
link for each below:
- [FAQs](https://github.com/ProjectCleverWeb/PEERS/blob/master/FAQ.md)
- [Contributing](https://github.com/ProjectCleverWeb/PEERS/blob/master/CONTRIBUTING.md)
- [Definitions](https://github.com/ProjectCleverWeb/PEERS/blob/master/DEFINITIONS.md)
## Licensing
The PEER Standards documentation by Nicholas Jordon is licensed under the [Creative Commons Attribution-ShareAlike 4.0 International License](http://creativecommons.org/licenses/by-sa/4.0/).
The PEER Standards source code by Nicholas Jordon is licensed under the [MIT License](http://opensource.org/licenses/MIT).