https://sourceforge.net/p/postfixadmin/wiki/Coding_guidelines/Recent changes to Coding_guidelinesenFri, 09 Mar 2018 10:07:45 -0000https://sourceforge.net/p/postfixadmin/wiki/Coding_guidelines/<div class="markdown_content"><pre>--- v1 +++ v2 @@ -1,38 +1,3 @@ -Postfixadmin doesn't have a tons of papers describing coding guidelines ;-) however there are some basic things you should honor: +Postfixadmin doesn't have a tons of papers describing coding guidelines ;-). It's recently migrated to PSR2 via PHPCS ( See: https://github.com/postfixadmin/postfixadmin/commit/15df6c1d7b5b1e254a9e478fca21de2b13a704b0 etc). -Programming style ---- - -* include the opening curly brackets in the statement's line. Example: - - - function fred($arg1, $arg2) { - if($arg1 == false) { - return true; - } - # etc. - } - - -* avoid copying code - * that creates a maintenance hell - * instead move the code to a file/function that can be used from everywhere - * if you need a slightly different behaviour, use if() (and maybe a function parameter). -* Again: Avoid copying code. - -Technical details ---- - -* spaces, not tabs -* 4 space indentation (some files still use 3 spaces for historical reasons) - * if you use vim as editor, it will automatically honor this by using the vim: comments in every file - * of course you can use any text editor you like ;-) - -SVN directory layout ---- - -* _trunk/_ is the development version - most work is done here. -* _branches/postfixadmin-X.Y/_ (where X and Y are numbers) are maintenance branches for PostfixAdmin X.Y.* releases -* _branches/*/_ (anything except "postfixadmin-X.Y") can be used for developing bigger changes etc. -* _tags/_ contains a fixed version of every PostfixAdmin release. Never commit to this directory! -* _website/_ contains the postfixadmin.sf.net website +Code however you want to, then run 'composer check-format' ... </pre> </div>GingerDogFri, 09 Mar 2018 10:07:45 -0000https://sourceforge.net8ad88fada2c7170cb34177fa8ac3570c147022e6https://sourceforge.net/p/postfixadmin/wiki/Coding_guidelines/<div class="markdown_content"><p>Postfixadmin doesn't have a tons of papers describing coding guidelines ;-) however there are some basic things you should honor:</p> <h2 id="programming-style">Programming style</h2> <ul> <li> <p>include the opening curly brackets in the statement's line. Example:</p> <div class="codehilite"><pre><span class="kd">function</span> <span class="nx">fred</span><span class="p">(</span><span class="nx">$arg1</span><span class="p">,</span> <span class="nx">$arg2</span><span class="p">)</span> <span class="p">{</span> <span class="k">if</span><span class="p">(</span><span class="nx">$arg1</span> <span class="o">==</span> <span class="kc">false</span><span class="p">)</span> <span class="p">{</span> <span class="k">return</span> <span class="kc">true</span><span class="p">;</span> <span class="p">}</span> <span class="err">#</span> <span class="nx">etc</span><span class="p">.</span> <span class="p">}</span> </pre></div> </li> <li> <p>avoid copying code</p> <ul> <li>that creates a maintenance hell</li> <li>instead move the code to a file/function that can be used from everywhere</li> <li>if you need a slightly different behaviour, use if() (and maybe a function parameter).</li> </ul> </li> <li>Again: Avoid copying code.</li> </ul> <h2 id="technical-details">Technical details</h2> <ul> <li>spaces, not tabs</li> <li>4 space indentation (some files still use 3 spaces for historical reasons)<ul> <li>if you use vim as editor, it will automatically honor this by using the vim: comments in every file</li> <li>of course you can use any text editor you like ;-)</li> </ul> </li> </ul> <h2 id="svn-directory-layout">SVN directory layout</h2> <ul> <li><em>trunk/</em> is the development version - most work is done here.</li> <li><em>branches/postfixadmin-X.Y/</em> (where X and Y are numbers) are maintenance branches for PostfixAdmin X.Y.* releases</li> <li><em>branches/*/</em> (anything except "postfixadmin-X.Y") can be used for developing bigger changes etc.</li> <li><em>tags/</em> contains a fixed version of every PostfixAdmin release. Never commit to this directory!</li> <li><em>website/</em> contains the postfixadmin.sf.net website</li> </ul></div>Christian BoltzSat, 25 Oct 2014 20:42:16 -0000https://sourceforge.net07a284fed90a906982fa2ecce9393fdbd157d387