Copilot instructions

1---
2applyTo: "app/i18n/*/*.php"
3description: Editing FreshRSS translations
4---
5 
6# FreshRSS translations (i18n)
7 
8* Favour commands over manual edits to add, move, or delete translation keys:
9	* Use the `cli/manipulate.translation.php` script or the corresponding `make` commands.
10 
11## Commands
12 
13### Add a new translation key
14 
15To add a new translatable string across all languages:
16 
17```sh
18./cli/manipulate.translation.php --action add --key 'example.of.key' --value 'Example of text'
19# or
20make i18n-add-key key='example.of.key' value='Example of text'
21```
22 
23This will:
241. Add the key to English (`app/i18n/en/gen.php`) with the provided value
252. Add the key to all other languages marked as `// TODO` for translators
26 
27You should then:
281. Remove the `// TODO` comment in English `en/`
292. Update to `// IGNORE` comment in US English `en-US/` or adapt the string in case of regional differences
30 
31### Delete a translation key
32 
33To delete a translation key from all languages:
34 
35```sh
36./cli/manipulate.translation.php --action delete --key 'old.key.path'
37```
38 
39### Other commands
40 
41See all available commands with:
42 
43```sh
44./cli/manipulate.translation.php -a --help
45```
46 
47## Post-fixing
48 
49After manipulating translation, you should call the following to reformat and ensure consistency:
50 
51```sh
52composer run-script translations
53# or (targeting more than just translations)
54make fix-all
55```
56