aly/servatrice
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Update CONTRIBUTING.md

Browse source
This commit is contained in:
ctrlaltca 2015-03-21 22:26:10 +01:00
parent b96604d85d
commit 09778535e8
1 changed files with 26 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

30
CONTRIBUTING.md
View file

@ -133,15 +133,37 @@ mutating objects.)
When pointers can't be avoided, try to use a smart pointer of some sort, such When pointers can't be avoided, try to use a smart pointer of some sort, such
as `QScopedPointer`, or, less preferably, `QSharedPointer`. as `QScopedPointer`, or, less preferably, `QSharedPointer`.
### Translations: introduction ###
Basic workflow for translations:
1. developer adds a tr("foo") string in the code;
2. every few days, a mantainer updates the *_en.ts files adding the new strings;
3. Trasifex picks up the new files from github every 24 hours;
4. translators translate the new untraslated strings on Transifex;
5. before a release, a mantainer fetches the updated translations from Transifex.
### Translations (for developers) ### ### Translations (for developers) ###
All the user-interface strings inside Cockatrice's source code must be written in All the user-interface strings inside Cockatrice's source code must be written in
english language. Translations to other languages are managed using [Transifex](https://www.transifex.com/projects/p/cockatrice/). english language. Translations to other languages are managed using [Transifex](https://www.transifex.com/projects/p/cockatrice/).
If you're about to propose a change that adds or modifies any translatable string If you're about to propose a change that adds or modifies any translatable string
in the code, you'll need to update the basic translation files so that translators in the code, you don't need to take care of adding the new strings to the
are notified that new strings needs to be translated. translation files. Every few days, or when a lot of new strings have been added,
To update the basic translation files, re-run cmake with enabling the appropriate someone from the development team will take care of extracing all the new strings,
adding them to the english translation file and making them available to
translators on Transifex.
### Translations (for mantainers) ###
#### step 2: updating *_en.ts files ####
When new translatable strings have been added to the code, it would be nice to
make them available to translators on Transifex. Every few days, or when a lot
of new strings have been added, a mantainer should take care of extracing all
the new strings and add them to the english translation.
To update the english translation files, re-run cmake enabling the appropriate
parameter and then run make: parameter and then run make:
cd cockatrice/build cd cockatrice/build
@ -169,7 +191,7 @@ Transifex will pick up the modified files automatically (checks every 24 hours)
and update the interface where translators will be able to translate the new and update the interface where translators will be able to translate the new
strings. strings.
### Translations (for mantainers) ### #### step 5: fetch new translations ####
Before rushing out a new release, it would be nice to fetch the most up to date Before rushing out a new release, it would be nice to fetch the most up to date
translations from Transifex and commit them into the Cockatrice source code. translations from Transifex and commit them into the Cockatrice source code.