src/psensor/contribute.adoc

   1 = How to contribute to psensor
   2 :docinfo2:
   3 :icons: font
   4
   5 == Translations
   6
   7 Psensor is fully translatable, and contributions to the translation
   8 for any language are welcome.
   9
  10 The contributions to the translation of `psensor` will be licensed
  11 like the code of `psensor` (GPLv2).
  12
  13 === Directly update the translation files
  14
  15 You can modify the .po files which are available in the
  16 GIT repository (https://git.wpitchoune.net/psensor.git) and send it to
  17 jeanfi@gmail.com.
  18
  19 First, checkout the last version of the sources:
  20
  21 ----
  22 git clone https://git.wpitchoune.net/psensor.git
  23 ----
  24
  25 Then, modify one of the .po file corresponding
  26 to your language in `psensor/po`. link:http://poedit.net[poedit] or any text
  27 editors supporting UTF-8 can be used to edit the translation files .
  28
  29 Finally, send the `.po` file to jeanfi@gmail.com.
  30
  31 If the `.po` file does not exist for your language, send me an email, I
  32 will add it.
  33
  34 === Use Launchpad
  35
  36 WARNING: Currently, you must NOT use this way. Due to a link:https://bugs.launchpad.net/ubuntu/+source/bzr-git/+bug/1084403[bug] which
  37 prevents to import GIT repository to Bazaar branch, it is impossible
  38 to synchronize the translations.
  39
  40 The easiest way is probably to use the Launchpad translation Web
  41 service available at:
  42 https://translations.launchpad.net/psensor/trunk/+translations.
  43
  44 If you did not already use it, you can read some documentation at:
  45 https://help.launchpad.net/Translations. The LP translations are
  46 periodically merged in the Psensor source repository and systematicaly
  47 before each release.
  48
  49 == Source code
  50
  51 Patch fixing bugs or adding features are welcome.
  52
  53 The code modification must be submitted as a patch file on the branch
  54 `master` of the GIT repository:
  55
  56 . Checkout the source code: `git clone http://git.wpitchoune.net/psensor.git`
  57
  58 . Modify the files
  59
  60 . Generate the patch file: `git diff >/tmp/mypatch.diff`
  61
  62 . Verify that it respects the coding style: `make check`
  63
  64 . Send the patch file by email to jeanfi@gmail.com
  65
  66 If it concerns a bug which does not exist on the ‘master’ GIT branch,
  67 the patch must be done on the appropriate GIT branch:
  68 http://git.wpitchoune.net/gitweb/?p=psensor.git;a=summary.
  69
  70 == Icons
  71
  72 Psensor is using 3 differents icons:
  73
  74 * link:http://git.wpitchoune.net/gitweb/?p=psensor.git;a=blob_plain;f=icons/hicolor/scalable/psensor.svg;hb=HEAD[an application icon]
  75
  76 * link:http://git.wpitchoune.net/gitweb/?p=psensor.git;a=blob_plain;f=icons/hicolor/scalable/psensor_normal.svg;hb=HEAD[a status icon]
  77
  78 * link: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]
  79
  80 and provides icons for 3 different themes:
  81
  82 * link:http://git.wpitchoune.net/gitweb/?p=psensor.git;a=tree;f=icons/hicolor/scalable;hb=HEAD[hicolor, the default theme for most desktop environment]
  83
  84 * link:http://git.wpitchoune.net/gitweb/?p=psensor.git;a=tree;f=icons/ubuntu-mono-dark;hb=HEAD[the default ubuntu monochrome dark theme]
  85
  86 * link:http://git.wpitchoune.net/gitweb/?p=psensor.git;a=tree;f=icons/ubuntu-mono-light;hb=HEAD[the default ubuntu monochrome light theme]
  87
  88 The status icons for Ubuntu themes have been provided by Christoph
  89 Buchner and are nice but definitively not the application icon.
  90
  91 Contributions to the icons are welcome for the already existent themes
  92 or others. To submit a new icon it must:
  93
  94 * be an original work (not confusing with another application icons)
  95   and released under GPL v2 license.
  96
  97 * use the .SVG format.
  98
  99 * be sent to me by email (jeanfi@gmail.com).