Details

    • Type: Documentation Documentation
    • Status: Open
    • Priority: Major Major
    • Resolution: Unresolved
    • Affects Version/s: None
    • Fix Version/s: 2.x
    • Component/s: None
    • Security Level: All
    • Labels:

      Description

      We need a new coding standards document for Doctrine 2.

        Issue Links

          Activity

          Hide
          Benjamin Morel added a comment -

          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!

          Show
          Benjamin Morel added a comment - 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!
          Hide
          Marco Pivetta added a comment -

          Benjamin Morel Guilherme Blanco 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

          Show
          Marco Pivetta added a comment - Benjamin Morel Guilherme Blanco 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
          Hide
          Benjamin Morel added a comment - - edited

          Ok, I'll post my document here once ready, and Guilherme Blanco will be able to compare it with his ruleset!

          Show
          Benjamin Morel added a comment - - edited Ok, I'll post my document here once ready, and Guilherme Blanco will be able to compare it with his ruleset!
          Hide
          Benjamin Morel added a comment -

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

          Please comment!

          Show
          Benjamin Morel added a comment - Here is a first draft: https://gist.github.com/4676670 Please comment!
          Hide
          Benjamin Morel added a comment - - edited

          Guilherme Blanco, 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?

          Show
          Benjamin Morel added a comment - - edited Guilherme Blanco , 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?
          Hide
          Benjamin Morel added a comment -

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

          Show
          Benjamin Morel added a comment - Any update guys? I'm willing to spend some time on this work, but if no one answers, we won't be going forward
          Hide
          Marco Pivetta added a comment -

          Benjamin Morel I think a pull request against the doctrine website (https://github.com/doctrine/doctrine-website-sphinx) would be fine...

          Show
          Marco Pivetta added a comment - Benjamin Morel I think a pull request against the doctrine website ( https://github.com/doctrine/doctrine-website-sphinx ) would be fine...
          Hide
          Steve Müller added a comment -

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

          Show
          Steve Müller added a comment - This should go into https://github.com/doctrine/coding-standard repo (long term).
          Hide
          Phansys added a comment -

          Could we define PSR-2 as base?

          Show
          Phansys added a comment - Could we define PSR-2 as base?
          Hide
          Marco Pivetta added a comment -

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

          Show
          Marco Pivetta added a comment - Please just refer to https://github.com/doctrine/coding-standard , which is already PSR-2 based (with variations and more strictness)
          Hide
          Phansys added a comment -

          @ocramius, Is there a rule for spaces arround `!` operator? https://github.com/doctrine/doctrine2/pull/1133#discussion_r17459791

          Show
          Phansys added a comment - @ocramius, Is there a rule for spaces arround `!` operator? https://github.com/doctrine/doctrine2/pull/1133#discussion_r17459791
          Hide
          Phansys added a comment -

          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?

          Show
          Phansys added a comment - 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?
          Hide
          Marco Pivetta added a comment - - edited

          Phansys yes, that's doctrine specific (spaces around {{ ! }} )

          Show
          Marco Pivetta added a comment - - edited Phansys yes, that's doctrine specific (spaces around {{ ! }} )
          Show
          Phansys added a comment - Perfect! https://github.com/FriendsOfPHP/PHP-CS-Fixer/pull/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

            People

            • Assignee:
              Jonathan H. Wage
              Reporter:
              Roman S. Borschel
            • Votes:
              1 Vote for this issue
              Watchers:
              4 Start watching this issue

              Dates

              • Created:
                Updated: