miracle091/SafeEyes
miracle091
/
SafeEyes
mirror of https://github.com/slgobinath/SafeEyes.git
1
0
Fork 0
Code Issues Releases Wiki Activity

Document validate_po.py script in readme and github PR template

This commit is contained in:
deltragon 2024-08-07 15:06:41 +02:00
parent 670cfc4d93
commit 3a8e5b0cb9
2 changed files with 13 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
.github/pull_request_template.md vendored Normal file
View File

@ -0,0 +1,5 @@
## Description
Describe your changes here, and link to related issues if available.
Reminder to run `python validate_po.py --extract` if you have added new translatable strings.

8
README.md
View File

@ -184,6 +184,14 @@ For more details, please check the issue: [#329](https://github.com/slgobinath/S
Thirdparty plugins are available at another GitHub repository: [safeeyes-plugins](https://github.com/slgobinath/safeeyes-plugins). More details about how to write your own plugin and how to install third-party plugin are available there.
## Local development
When adding new translatable strings in the source code, make sure to run `python validate_po.py --extract` to add them to the translation template. You will need to install `python3-polib` for this.
Examples for translatable strings are `_("This is a string")` in Python code, or `<property name="label" translatable="yes">This is a label</property>` in Glade/xml files.
To ensure the new strings are well-formed, you can use `python validate_po.py --validate`.
## How to Release?
0. Run `update-po.sh` to generate new translation files (which will be eventually updated by translators). Commit and push the changes to the master branch.