DDC-585: Create a coding standards document

[doctrinebot]

Jira issue originally created by user romanb:

We need a new coding standards document for Doctrine 2.

[doctrinebot]

• is referenced by DDC-3841: [GH-1470] [CI] Added dev requirement for "doctrine/coding-standard"
• is referenced by DDC-2408: [GH-649] Update coding standards

[doctrinebot]

Comment created by benjamin:

Has there been any work on a coding standards document yet?
I'm currently working on fixing documentation on this project, and it might be a good time to define a standard.
I've started compiling a few recommendations based on various feedbacks I've got in my pull requests, and I can post them here.
Please let me know if there have been previous attempts so far!

[doctrinebot]

Comment created by @Ocramius:

[_{benjamin] [}guiblanco] may have a CS ruleset, but it's not ready yet. Perfect timing btw, we really need to automate this to avoid having all these useless CS fix comments in pull requests

[doctrinebot]

Comment created by benjamin:

Ok, I'll post my document here once ready, and [~guiblanco] will be able to compare it with his ruleset!

[doctrinebot]

Comment created by benjamin:

Here is a first draft: https://gist.github.com/4676670

Please comment!

[doctrinebot]

Comment created by benjamin:

[~guiblanco], if you don't have time to compare your ruleset with my draft, maybe you could publish your current ruleset so that others can have a look?

[doctrinebot]

Comment created by benjamin:

Any update guys? I'm willing to spend some time on this work, but if no one answers, we won't be going forward :(

[doctrinebot]

Comment created by @Ocramius:

[~benjamin] I think a pull request against the doctrine website (https://github.com/doctrine/doctrine-website-sphinx) would be fine...

[doctrinebot]

Comment created by @deeky666:

This should go into https://github.com/doctrine/coding-standard repo (long term).

[doctrinebot]

Comment created by phansys:

Could we define PSR-2 as base?

[doctrinebot]

Comment created by @Ocramius:

Please just refer to https://github.com/doctrine/coding-standard, which is already PSR-2 based (with variations and more strictness)

[doctrinebot]

Comment created by phansys:

@Ocramius, Is there a rule for spaces arround ! operator? #1133 (comment)

[doctrinebot]

Comment created by phansys:

I just found another set of rules inside https://github.com/doctrine/doctrine2/blob/14ff7f50cfea67d8a4dca37b8ca364d2a83b9864/CONTRIBUTING.md#coding-standard. Which is the current valid standard?

[doctrinebot]

Comment created by @Ocramius:

[~phansys] yes, that's doctrine specific (spaces around ! )

[doctrinebot]

Comment created by phansys:

Perfect! PHP-CS-Fixer/PHP-CS-Fixer#1303
What about the disambiguation between the CS? https://github.com/doctrine/coding-standard/tree/master/Docs#doctrine-coding-standard vs https://github.com/doctrine/doctrine2/blob/14ff7f50cfea67d8a4dca37b8ca364d2a83b9864/CONTRIBUTING.md#coding-standard

[Majkl578]

I think we can safely close this as Doctrine Coding Standard is now adopted by (almost all) Doctrine projects and also documented in README and (soon) on the website too. ☺️