= How to contribute to psensor
:docinfo2:
:icons: font

== Translations

Psensor is fully translatable, and contributions to the translation
for any language are welcome.

The contributions to the translation of `psensor` will be licensed
like the code of `psensor` (GPLv2).

=== Directly update the translation files

You can modify the .po files which are available in the
GIT repository (https://gitlab.com/jeanfi/psensor.git) and send it to
jeanfi@gmail.com.

First, checkout the last version of the sources:

----
git clone https://gitlab.com/jeanfi/psensor.git
----

Then, modify one of the .po file corresponding
to your language in `psensor/po`. link:http://poedit.net[poedit] or any text
editors supporting UTF-8 can be used to edit the translation files .

Finally, send the `.po` file to jeanfi@gmail.com.

If the `.po` file does not exist for your language, send me an email, I
will add it.

=== Use Launchpad

WARNING: Currently, you must NOT use this way. Due to a link:https://bugs.launchpad.net/ubuntu/+source/bzr-git/+bug/1084403[bug] which
prevents to import GIT repository to Bazaar branch, it is impossible
to synchronize the translations.

The easiest way is probably to use the Launchpad translation Web
service available at:
https://translations.launchpad.net/psensor/trunk/+translations.

If you did not already use it, you can read some documentation at:
https://help.launchpad.net/Translations. The LP translations are
periodically merged in the Psensor source repository and systematicaly
before each release.

== Source code

Patch fixing bugs or adding features are welcome.

The code modification must be submitted as a patch file on the branch
`master` of the GIT repository:

. Checkout the source code: `git clone https://gitlab.com/jeanfi/psensor.git`

. Modify the files

. Generate the patch file: `git diff >/tmp/mypatch.diff`

. Verify that it respects the coding style: `make check`

. Send the patch file by email to jeanfi@gmail.com

If it concerns a bug which does not exist on the ‘master’ GIT branch,
the patch must be done on the appropriate GIT branch:
https://gitlab.com/jeanfi/psensor/branches

== Icons

Psensor is using 3 differents icons:

* link:https://gitlab.com/jeanfi/psensor/blob/master/icons/hicolor/scalable/psensor.svg[an application icon]

* link:https://gitlab.com/jeanfi/psensor/blob/master/icons/hicolor/scalable/psensor_normal.svg[a status icon]

* link:https://gitlab.com/jeanfi/psensor/blob/master/icons/hicolor/scalable/psensor_hot.svg[a status icon when there is a sensor alert]

and provides icons for 3 different themes:

* link:https://gitlab.com/jeanfi/psensor/blob/master/icons/hicolor/scalable[hicolor, the default theme for most desktop environment]

* link:https://gitlab.com/jeanfi/psensor/blob/master/icons/ubuntu-mono-dark[the default ubuntu monochrome dark theme]

* link:https://gitlab.com/jeanfi/psensor/blob/master/icons/ubuntu-mono-light[the default ubuntu monochrome light theme]

The status icons for Ubuntu themes have been provided by Christoph
Buchner and are nice but definitively not the application icon.

Contributions to the icons are welcome for the already existent themes
or others. To submit a new icon it must:

* be an original work (not confusing with another application icons)
  and released under GPL v2 license.

* use the .SVG format.

* be sent to me by email (jeanfi@gmail.com).
