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 <script src="https://apis.google.com/js/platform.js" async defer>
16 <body class="article">
18 <h1>How to contribute to psensor</h1>
22 <h2 id="_translations">Translations</h2>
23 <div class="sectionbody">
24 <div class="paragraph">
25 <p>Psensor is fully translatable, and contributions to the translation
26 for any language are welcome.</p>
29 <h3 id="_directly_update_the_translation_files">Directly update the translation files</h3>
30 <div class="paragraph">
31 <p>You can modify the .po files which are available in the
32 GIT repository: <a href="http://git.wpitchoune.net/psensor.git" class="bare">http://git.wpitchoune.net/psensor.git</a> and send it to
33 <a href="mailto:jeanfi@gmail.com">jeanfi@gmail.com</a>.</p>
35 <div class="paragraph">
36 <p><a href="http://poedit.net">poedit</a> or any text editors supporting UTF-8
37 can be used to edit the translation files .</p>
39 <div class="paragraph">
40 <p>If the <code>.po</code> file does not exist for your language, send me an email, I
45 <h3 id="_use_launchpad">Use Launchpad</h3>
46 <div class="admonitionblock warning">
50 <i class="fa icon-warning" title="Warning"></i>
53 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
54 prevents to import GIT repository to Bazaar branch, it is impossible
55 to synchronize the translations.
60 <div class="paragraph">
61 <p>The easiest way is probably to use the Launchpad translation Web
63 <a href="https://translations.launchpad.net/psensor/trunk/+translations" class="bare">https://translations.launchpad.net/psensor/trunk/+translations</a>.</p>
65 <div class="paragraph">
66 <p>If you did not already use it, you can read some documentation at:
67 <a href="https://help.launchpad.net/Translations" class="bare">https://help.launchpad.net/Translations</a>. The LP translations are
68 periodically merged in the Psensor source repository and systematicaly
69 before each release.</p>
75 <h2 id="_source_code">Source code</h2>
76 <div class="sectionbody">
77 <div class="paragraph">
78 <p>Patch fixing bugs or adding features are welcome.</p>
80 <div class="paragraph">
81 <p>The code modification must be submitted as a patch file on the branch
82 <code>master</code> of the GIT repository:</p>
84 <div class="olist arabic">
87 <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>
90 <p>Modify the files</p>
93 <p>Generate the patch file: <code>git diff >/tmp/mypatch.diff</code></p>
96 <p>Verify that it respects the coding style: <code>make check</code></p>
99 <p>Send the patch file by email to <a href="mailto:jeanfi@gmail.com">jeanfi@gmail.com</a></p>
103 <div class="paragraph">
104 <p>If it concerns a bug which does not exist on the ‘master’ GIT branch,
105 the patch must be done on the appropriate GIT branch:
106 <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>
111 <h2 id="_icons">Icons</h2>
112 <div class="sectionbody">
113 <div class="paragraph">
114 <p>Psensor is using 3 differents icons:</p>
119 <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>
122 <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>
125 <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>
129 <div class="paragraph">
130 <p>and provides icons for 3 different themes:</p>
135 <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>
138 <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>
141 <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>
145 <div class="paragraph">
146 <p>The status icons for Ubuntu themes have been provided by Christoph
147 Buchner and are nice but definitively not the application icon.</p>
149 <div class="paragraph">
150 <p>Contributions to the icons are welcome for the already existent themes
151 or others. To submit a new icon it must:</p>
156 <p>be an original work (not confusing with another application icons)
157 and released under GPL v2 license.</p>
160 <p>use the .SVG format.</p>
163 <p>be sent to me by email (<a href="mailto:jeanfi@gmail.com">jeanfi@gmail.com</a>).</p>
171 <div id="footer-text">
172 Last updated 2016-06-14 21:30:49 CEST