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>
28 <div class="paragraph">
29 <p>The contributions to the translation of <code>psensor</code> will be licensed
30 like the code of <code>psensor</code> (GPLv2).</p>
33 <h3 id="_directly_update_the_translation_files">Directly update the translation files</h3>
34 <div class="paragraph">
35 <p>You can modify the .po files which are available in the
36 GIT repository (<a href="https://git.wpitchoune.net/psensor.git" class="bare">https://git.wpitchoune.net/psensor.git</a>) and send it to
37 <a href="mailto:jeanfi@gmail.com">jeanfi@gmail.com</a>.</p>
39 <div class="paragraph">
40 <p>First, checkout the last version of the sources:</p>
42 <div class="listingblock">
44 <pre>git clone https://git.wpitchoune.net/psensor.git</pre>
47 <div class="paragraph">
48 <p>Then, modify one of the .po file corresponding
49 to your language in <code>psensor/po</code>. <a href="http://poedit.net">poedit</a> or any text
50 editors supporting UTF-8 can be used to edit the translation files .</p>
52 <div class="paragraph">
53 <p>Finally, send the <code>.po</code> file to <a href="mailto:jeanfi@gmail.com">jeanfi@gmail.com</a>.</p>
55 <div class="paragraph">
56 <p>If the <code>.po</code> file does not exist for your language, send me an email, I
61 <h3 id="_use_launchpad">Use Launchpad</h3>
62 <div class="admonitionblock warning">
66 <i class="fa icon-warning" title="Warning"></i>
69 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
70 prevents to import GIT repository to Bazaar branch, it is impossible
71 to synchronize the translations.
76 <div class="paragraph">
77 <p>The easiest way is probably to use the Launchpad translation Web
79 <a href="https://translations.launchpad.net/psensor/trunk/+translations" class="bare">https://translations.launchpad.net/psensor/trunk/+translations</a>.</p>
81 <div class="paragraph">
82 <p>If you did not already use it, you can read some documentation at:
83 <a href="https://help.launchpad.net/Translations" class="bare">https://help.launchpad.net/Translations</a>. The LP translations are
84 periodically merged in the Psensor source repository and systematicaly
85 before each release.</p>
91 <h2 id="_source_code">Source code</h2>
92 <div class="sectionbody">
93 <div class="paragraph">
94 <p>Patch fixing bugs or adding features are welcome.</p>
96 <div class="paragraph">
97 <p>The code modification must be submitted as a patch file on the branch
98 <code>master</code> of the GIT repository:</p>
100 <div class="olist arabic">
103 <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>
106 <p>Modify the files</p>
109 <p>Generate the patch file: <code>git diff >/tmp/mypatch.diff</code></p>
112 <p>Verify that it respects the coding style: <code>make check</code></p>
115 <p>Send the patch file by email to <a href="mailto:jeanfi@gmail.com">jeanfi@gmail.com</a></p>
119 <div class="paragraph">
120 <p>If it concerns a bug which does not exist on the ‘master’ GIT branch,
121 the patch must be done on the appropriate GIT branch:
122 <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>
127 <h2 id="_icons">Icons</h2>
128 <div class="sectionbody">
129 <div class="paragraph">
130 <p>Psensor is using 3 differents icons:</p>
135 <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>
138 <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>
141 <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>
145 <div class="paragraph">
146 <p>and provides icons for 3 different themes:</p>
151 <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>
154 <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>
157 <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>
161 <div class="paragraph">
162 <p>The status icons for Ubuntu themes have been provided by Christoph
163 Buchner and are nice but definitively not the application icon.</p>
165 <div class="paragraph">
166 <p>Contributions to the icons are welcome for the already existent themes
167 or others. To submit a new icon it must:</p>
172 <p>be an original work (not confusing with another application icons)
173 and released under GPL v2 license.</p>
176 <p>use the .SVG format.</p>
179 <p>be sent to me by email (<a href="mailto:jeanfi@gmail.com">jeanfi@gmail.com</a>).</p>
187 <div id="footer-text">
188 Last updated 2016-07-04 09:56:32 CEST
191 Feed: <a href="https://wpitchoune.net/news/feed.xml">RSS 2.0</a>