www/psensor/contribute.html

   1 <!DOCTYPE html>
   2 <html lang="en">
   3 <head>
   4 <meta charset="UTF-8">
   5 <!--[if IE]><meta http-equiv="X-UA-Compatible" content="IE=edge"><![endif]-->
   6 <meta name="viewport" content="width=device-width, initial-scale=1.0">
   7 <meta name="generator" content="Asciidoctor 1.5.4">
   8 <title>How to contribute to psensor</title>
   9 <link rel="stylesheet" href="./../style.css">
  10 <script src="https://ajax.googleapis.com/ajax/libs/jquery/2.2.4/jquery.min.js"></script>
  11 <script src="nav.js"></script>
  12 </head>
  13 <body class="article">
  14 <div id="header">
  15 <h1>How to contribute to psensor</h1>
  16 </div>
  17 <div id="content">
  18 <div class="sect1">
  19 <h2 id="_translations">Translations</h2>
  20 <div class="sectionbody">
  21 <div class="paragraph">
  22 <p>Psensor is fully translatable, and contributions to the translation
  23 for any language are welcome.</p>
  24 </div>
  25 <div class="sect2">
  26 <h3 id="_directly_update_the_translation_files">Directly update the translation files</h3>
  27 <div class="paragraph">
  28 <p>You can modify the .po files which are available in the
  29 GIT repository: <a href="http://git.wpitchoune.net/psensor.git" class="bare">http://git.wpitchoune.net/psensor.git</a> and send it to
  30 <a href="mailto:jeanfi@gmail.com">jeanfi@gmail.com</a>.</p>
  31 </div>
  32 <div class="paragraph">
  33 <p><a href="http://poedit.net">poedit</a> or any text editors supporting UTF-8
  34 can be used to edit the translation files .</p>
  35 </div>
  36 <div class="paragraph">
  37 <p>If the <code>.po</code> file does not exist for your language, send me an email, I
  38 will add it.</p>
  39 </div>
  40 </div>
  41 <div class="sect2">
  42 <h3 id="_use_launchpad">Use Launchpad</h3>
  43 <div class="admonitionblock warning">
  44 <table>
  45 <tr>
  46 <td class="icon">
  47 <div class="title">Warning</div>
  48 </td>
  49 <td class="content">
  50 Currently, you must NOT use this way. Due to a <a href="https://bugs.launchpad.net/ubuntu/+source/bzr-git/+bug/1084403">bug</a> which
  51 prevents to import GIT repository to Bazaar branch, it is impossible
  52 to synchronize the translations.
  53 </td>
  54 </tr>
  55 </table>
  56 </div>
  57 <div class="paragraph">
  58 <p>The easiest way is probably to use the Launchpad translation Web
  59 service available at:
  60 <a href="https://translations.launchpad.net/psensor/trunk/+translations" class="bare">https://translations.launchpad.net/psensor/trunk/+translations</a>.</p>
  61 </div>
  62 <div class="paragraph">
  63 <p>If you did not already use it, you can read some documentation at:
  64 <a href="https://help.launchpad.net/Translations" class="bare">https://help.launchpad.net/Translations</a>. The LP translations are
  65 periodically merged in the Psensor source repository and systematicaly
  66 before each release.</p>
  67 </div>
  68 </div>
  69 </div>
  70 </div>
  71 <div class="sect1">
  72 <h2 id="_source_code">Source code</h2>
  73 <div class="sectionbody">
  74 <div class="paragraph">
  75 <p>Patch fixing bugs or adding features are welcome.</p>
  76 </div>
  77 <div class="paragraph">
  78 <p>The code modification must be submitted as a patch file on the SVN
  79 ‘trunk’:</p>
  80 </div>
  81 <div class="olist arabic">
  82 <ol class="arabic">
  83 <li>
  84 <p>Checkout the source code: <code>git clone <a href="http://git.wpitchoune.net/psensor.git" class="bare">http://git.wpitchoune.net/psensor.git</a></code></p>
  85 </li>
  86 <li>
  87 <p>Modify the files</p>
  88 </li>
  89 <li>
  90 <p>Generate the patch file: <code>git diff &gt;/tmp/mypatch.diff</code></p>
  91 </li>
  92 <li>
  93 <p>Verify that it respects the coding style: <code>make check</code></p>
  94 </li>
  95 <li>
  96 <p>Send the patch file by email to <a href="mailto:jeanfi@gmail.com">jeanfi@gmail.com</a></p>
  97 </li>
  98 </ol>
  99 </div>
 100 <div class="paragraph">
 101 <p>If it concerns a bug which does not exist on the ‘master’ GIT branch,
 102 the patch must be done on the appropriate GIT branch:
 103 <a href="http://git.wpitchoune.net/gitweb/?p=psensor.git;a=summary" class="bare">http://git.wpitchoune.net/gitweb/?p=psensor.git;a=summary</a>.</p>
 104 </div>
 105 </div>
 106 </div>
 107 <div class="sect1">
 108 <h2 id="_icons">Icons</h2>
 109 <div class="sectionbody">
 110 <div class="paragraph">
 111 <p>Psensor is using 3 differents icons:</p>
 112 </div>
 113 <div class="ulist">
 114 <ul>
 115 <li>
 116 <p><a href="http://git.wpitchoune.net/gitweb/?p=psensor.git;a=blob_plain;f=icons/hicolor/scalable/psensor.svg;hb=HEAD">an application icon</a></p>
 117 </li>
 118 <li>
 119 <p><a href="http://git.wpitchoune.net/gitweb/?p=psensor.git;a=blob_plain;f=icons/hicolor/scalable/psensor_normal.svg;hb=HEAD">a status icon</a></p>
 120 </li>
 121 <li>
 122 <p><a href="http://git.wpitchoune.net/gitweb/?p=psensor.git;a=blob_plain;f=icons/hicolor/scalable/psensor_hot.svg;hb=HEAD">a status icon when there is a sensor alert</a></p>
 123 </li>
 124 </ul>
 125 </div>
 126 <div class="paragraph">
 127 <p>and provides icons for 3 different themes:</p>
 128 </div>
 129 <div class="ulist">
 130 <ul>
 131 <li>
 132 <p><a href="http://git.wpitchoune.net/gitweb/?p=psensor.git;a=tree;f=icons/hicolor/scalable;hb=HEAD">hicolor, the default theme for most desktop environment</a></p>
 133 </li>
 134 <li>
 135 <p><a href="http://git.wpitchoune.net/gitweb/?p=psensor.git;a=tree;f=icons/ubuntu-mono-dark;hb=HEAD">the default ubuntu monochrome dark theme</a></p>
 136 </li>
 137 <li>
 138 <p><a href="http://git.wpitchoune.net/gitweb/?p=psensor.git;a=tree;f=icons/ubuntu-mono-light;hb=HEAD">the default ubuntu monochrome light theme</a></p>
 139 </li>
 140 </ul>
 141 </div>
 142 <div class="paragraph">
 143 <p>The status icons for Ubuntu themes have been provided by Christoph
 144 Buchner and are nice but definitively not the application icon.</p>
 145 </div>
 146 <div class="paragraph">
 147 <p>Contributions to the icons are welcome for the already existent themes
 148 or others. To submit a new icon it must:</p>
 149 </div>
 150 <div class="ulist">
 151 <ul>
 152 <li>
 153 <p>be an original work (not confusing with another application icons)
 154 and released under GPL v2 license.</p>
 155 </li>
 156 <li>
 157 <p>use the .SVG format.</p>
 158 </li>
 159 <li>
 160 <p>be sent to me by email (<a href="mailto:jeanfi@gmail.com">jeanfi@gmail.com</a>).</p>
 161 </li>
 162 </ul>
 163 </div>
 164 </div>
 165 </div>
 166 </div>
 167 <div id="footer">
 168 <div id="footer-text">
 169 Last updated 2016-06-14 12:08:22 CEST
 170 </div>
 171 </div>
 172 </body>
 173 </html>