Submitting your vote...
If you are interested in the TYPO3 coding guidelines, you can download unofficial version in the end of the article. This version is not released officially by the core team. This is the same version that was approved by the joint meeting of TYPO3 community and TYPO3 core team at TYPO3 Developer Days 2008.
This is a draft document. While I did my best to make it correct English, there can still be typos and grammar errors. However they should not create any problems for reading.
The rest of this articles describes what happened to the coding guidelines and why they are not available officially to the community. You can skip the rest and proceed directly to the download below.
Why do I release CGL on my blog?
During TYPO3 Developer Days (T3DD08) TYPO3 community and TYPO3 core team discussed a new version of TYPO3 coding guidelines (CGL). Ingo Renner took responsibility to write and release coding guidelines ASAP. After half year time nothing happened despite many questions from the community. CGL is still not released.
I sensed that this work will never be done and prepared a draft of coding guidelines myself. This draft was submitted to the TYPO3 core team for review on August 4th. There were few reviews. Notes mainly came from Ingo and they were like the following:
- change "developer" to "you"
- we done need to say bla-bla-bla because it is obvious to everyone
I disagreed to those points because:
- technical documentation must use 3rd form. It is never “you” but always “he”, “she” or “user” or “developer”
- CGL is normative. It is like a law. There is no such thing as obvious in this case. Everything must be stated clearly
There were other remarks from people but were more like spelling or grammar. But nevertheless CGL was never approved by core team for publishing. Discussion just faded away leaving community without CGL.
I decided to publish CGL here because people ask for it very often. Also it is not really fare to ask people to follow CGL without providing CGL to public.
Download
Click below to download unofficial version of the TYPO3 coding guidelines.
CGL.pdf
TYPO3 coding guidelines already exists (http://typo3.org/documentation/document-library/core-documentation/doc_core_cgl/4.1.0/view/).
Wh[..] is the reason?
Ingo, thanks ;)
:)