templates/devel.tpl

   1 <html xmlns:py="http://genshi.edgewall.org/" xmlns:xi="http://www.w3.org/2001/XInclude" py:strip="">
   2
   3 <py:def function="page_title">Developing phpMyAdmin</py:def>
   4
   5 <div py:match="content" id="body">
   6
   7 <h2>Developing phpMyAdmin</h2>
   8
   9 <p>
  10 phpMyAdmin is (as the name says) written in PHP and uses MySQL. Besides this,
  11 we also need people skilled in HTML, JavaScript and CSS, as these are parts
  12 which make our user interface. You don't have to be expert in all these areas
  13 - even knowing only one of them, you can still provide substantial help in
  14 creating or debugging some features.
  15 </p>
  16
  17 <p>
  18 For storing our code we use <a href="http://git-scm.com/">Git</a>.
  19 If you don't know it, you can get some basic facts in <a
  20 href="http://en.wikipedia.org/wiki/Git_software">Wikipedia</a> or
  21 reference in the comprehensive book <a href="http://progit.org/">Pro Git</a>.
  22 </p>
  23
  24 <p>
  25 You can find more information for developers on our
  26 <a href="http://wiki.phpmyadmin.net/pma/Development">wiki</a>.
  27 </p>
  28
  29 <h3>Contributing code</h3>
  30 <p>
  31 Once you have coded an improvement and you are ready to submit it to us,
  32 please use our <a
  33 href="https://sourceforge.net/tracker/?group_id=23067&amp;atid=377410">patch
  34 tracker</a>, where developers will pick up your contributions or guide you
  35 through improving the patch.
  36 </p>
  37
  38 <h3>Simple tasks to start</h3>
  39 <p>
  40 If you are looking for some simple task where you can start, check out
  41 our wiki page with <a href="http://wiki.phpmyadmin.net/pma/Tasks_for_junior_developers">junior
  42 jobs</a> where you can find some tips where to look.
  43 </p>
  44
  45 <h3>Source Code Repository</h3>
  46 <xi:include href="_gitdl.tpl" />
  47
  48 <p>
  49 You are most likely interested in the <code>phpmyadmin</code> repository, which
  50 contains phpMyAdmin itself.
  51 </p>
  52
  53 <p>
  54 Full list of repositories include:
  55 </p>
  56
  57 <dl class="cvslist">
  58 <dt>phpmyadmin</dt><dd>phpMyAdmin code.</dd>
  59 <dt>website</dt><dd>Website code.</dd>
  60 <dt>themes</dt><dd>Custom themes.</dd>
  61 <dt>data</dt><dd>Various project related data (such as logos, T-shirt graphics, etc.).</dd>
  62 <dt>history</dt><dd>Some historical documents (old changelogs or website).</dd>
  63 <dt>planet</dt><dd><a href="http://planet.phpmyadmin.net/">Planet phpMyAdmin</a> configuration.</dd>
  64 <dt>localized_docs</dt><dd>Localized documentation.</dd>
  65 </dl>
  66
  67 <p>
  68 Examples of how to checkout phpMyAdmin code:
  69 </p>
  70
  71 <pre>
  72 #  Latest development version:
  73 git clone git://github.com/phpmyadmin/phpmyadmin.git
  74 </pre>
  75
  76 <h3>Repository Statistics</h3>
  77 <p>Several statistics about the repository are available:</p>
  78 <ul>
  79 <li><a href="http://cia.vc/stats/project/phpmyadmin/">CIA.vc</a></li>
  80 <li><a href="http://www.ohloh.net/projects/phpmyadmin">Ohloh</a></li>
  81 <li><a href="https://github.com/phpmyadmin/">github</a></li>
  82 </ul>
  83
  84 <h3>Coding Standards</h3>
  85 <p>
  86 Standards should be obeyed in all cases when possible. Generated content
  87 should be valid XHTML 1.0 and CSS. PHP code should match <a
  88 href="http://pear.php.net/manual/en/standards.php">PEAR Coding Standards</a>
  89 and documented using <a href="http://www.phpdoc.org/">phpDocumentator</a>.
  90 More information about coding is available on <a href="http://wiki.phpmyadmin.net/pma/Coding_guidelines">
  91 our wiki</a>.
  92 </p>
  93
  94 <h3>Developer Documentation</h3>
  95
  96 <p>More documentation can be found in the following places:</p>
  97 <ul>
  98 <li><a href="http://wiki.phpmyadmin.net/pma/Development">Developers wiki</a></li>
  99 <li><a href="http://www.phpmyadmin.net/phpdoc/">phpMyAdmin's internals
 100 (autogenerated via phpDocumentator)</a></li>
 101 </ul>
 102
 103
 104 </div>
 105
 106 <xi:include href="_page.tpl" />
 107 </html>
 108