Skip to content

Latest commit

 

History

History
98 lines (69 loc) · 2.71 KB

CONTRIBUTING.md

File metadata and controls

98 lines (69 loc) · 2.71 KB
Raw

Contributors' Guide

Developing

Testing

Testing is very important in this project, and coverage is high. Please respect this!

For tooling, we use tox. Just run tox. Coverage is reported in Coveralls.

Releasing

This is crudely semi-automated now:

bin/create_zip.sh release 1.3

will create squeeze-alexa-1.3.zip (hopefully) suitable for upload to Github etc.

Translation

squeeze-alexa uses GNU gettext. It's a little old-fashioned / troublesome at first, but it serves its purposes well.

I want to translate

Great! I wrote a script to help with that:

Update translations from source

This re-scans the source and recreates a master .pot file, before then updating the translations files (.pos).

bin/update-translations

Compile translations

This takes the .pos and makes binary .mos that are necessary for gettext to work.

bin/compile-translations

I have a new language

Great! Follow these steps (imagine you are choosing Brazilian Portuguese, pt_BR):

Create a directory

cd locale
LOCALE=pt_BR
mkdir -p $LOCALE/LC_MESSAGES

Generate a blank PO file

DOMAIN=squeeze-alexa
touch $LOCALE/LC_MESSAGES/$DOMAIN.po

Update the translations from source

(see above)

Translate your .po

You can edit the using any text editor, or use PoEdit, or any other gettext tools e.g.

Submit the translation

  • Hopefully you opened a Github issue - if not, do this.
  • Either attach the updated .po, or create a fork in Gibhut, branch, commit your new file(s) in Git, then make a Pull Request, mentioning the ticket number.

Translation FAQ

Everything's still in US English

  • Make sure you've set LOCALE in settings.py.
  • Make sure the directory is setup as above and you've definitely compiled it (i.e. there's a .mo file)
  • New versions of squeeze-alexa default to the source language (en_US) if there is no translation found.

What if I don't translate some strings?

No problem. They'll come out in the source language (en here).

I'm getting "invalid multibyte sequence" errors

This .po header is probably missing:

msgid ""
msgstr ""
"Content-Type: text/plain; charset=UTF-8\n"

There are newlines I didn't expect

xgettext reformats source files to a maximum line width according to its settings. See update-translations for the setup.