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