diff options
| author | Jules Aguillon | 2023-06-03 21:03:05 +0200 |
|---|---|---|
| committer | Jules Aguillon | 2023-06-03 21:03:05 +0200 |
| commit | e5ae4816df6a48d6ad61c32654f14f108cac6a34 (patch) | |
| tree | 199c15cbb5ded8d18aa83089b2c590abb3c0ea83 /CONTRIBUTING.md | |
| parent | f451902efa074a58953f9f5d69dd56812d854661 (diff) | |
| download | unexpected-keyboard-e5ae4816df6a48d6ad61c32654f14f108cac6a34.tar.gz unexpected-keyboard-e5ae4816df6a48d6ad61c32654f14f108cac6a34.zip | |
Add automated checks on layouts
The script `check_layout.py` checks some properties about layouts.
No check is an error.
The result of running this script on every layouts is stored in the file
`check_layout.output`, which is useful to track changes.
Add make rules to run this script as well as `sync_translations`.
Diffstat (limited to 'CONTRIBUTING.md')
| -rw-r--r-- | CONTRIBUTING.md | 9 |
1 files changed, 7 insertions, 2 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index ef19713..3ad2bf9 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -88,6 +88,9 @@ An entry must be added to the layout option in `res/values/arrays.xml`, to both The layout must also be referenced in `srcs/juloo.keyboard2/Config.java` in `layout_of_string`. +Run `make check_layouts` to check some properties about your layout. This will +change the file `check_layout.output`, which you should commit. + #### Adding a programming layout A programming layout must contains every ASCII characters. @@ -135,10 +138,12 @@ The app can be translated by writing `res/values-<language code>/strings.xml` (for example `values-fr`, `values-lv`), based on the default: `res/values/strings.xml` (English). +To check that `strings.xml` is formatted correctly, run +`python sync_translations.py`. This will modify your files. + The store description is found in `metadata/android/<locale>/`, `short_description.txt` and `full_description.txt`. -Translating changelogs is not useful. Changelogs are written quickly just -before a release and older ones are never shown to anyone currently. +Translating changelogs is not useful. The app name might be partially translated, the "unexpected" word should remain untranslated. |