search

Clicksco / PHP-Handbook

Our aim it to pull PHP developers together to work using the same tools and the same way. We believe that ensuring that having some best-practice and basic principles in place will play a big part in both team and personal development.
php.clicksco.com
1 stars 0 forks source link

Standards Section #9

Open jamesmills opened 10 years ago

jamesmills commented 10 years ago

There has been a conversation about adding some sort of standards document for the PHP team (like what the Front End guys have http://frontend.clicksco.com/standards/index.php/Introduction). The suggestion was put forward by @jonspark and my initial reaction was that we already have the handbook which states that we follow PSR for things like coding style so why do we need something else.

After giving this some thought I think we should implement @jonspark idea and add a Standards section to our handbook which will basically cover what from the handbook MUST, SHOULD, COULD or SHOULD NOT be followed. This allows us to add our own company standards to fit missing gaps within the PSR's (e.g. You SHOULD use $snake_case for properties, variables & parameters).

Examples:

I suggest that we start with the same introduction that the FE guys have used and expand from this.

(Ping: @jonspark @gingercoder @ampersarnie)

jamesmills commented 10 years ago

I cloned our handbook and created a new standards branch from the gh-pages branch. I just put in a pull request and merged this which you can see here.

https://github.com/Clicksco/PHP-Handbook/commit/943fc33bcf2998c553d6749d35106fbf3bea9440

All thoughts and ideas welcome.

@jonspark is this what you were thinking?

jonspark commented 10 years ago

Yeah, good start. What do you all think about the package/site used by the frontend group? http://frontend.clicksco.com/standards/index.php/Introduction

ampersarnie commented 10 years ago

I like where this is going. I definitely think it is the right thing to do, to push things forward. There are definitely a number of holes in the PSR's that we need to fill in ourselves. Fully support this move.

jamesmills commented 10 years ago

@ampersarnie can you come up with some more items for the proposed list please. I am thinking the holes you mentioned in your previous comment.

ampersarnie commented 10 years ago

@jamesmills Writing a couple to put up for suggestion. Some seem like obvious avoidance's to developers but I think they should be said. I'll create issues for each when I'm done.