docs: contributing update (#41)
Reviewed-on: https://git.kennel.ml/ConfrerieDuKassoulait/Botanique/pulls/41
This commit is contained in:
parent
7c3eb13e28
commit
06f19c2f84
1 changed files with 21 additions and 4 deletions
|
@ -32,6 +32,20 @@ La langue par défaut fait office de solution de secours dans le cas où une
|
|||
traduction est incomplète. On part donc du postulat que la langue par défaut
|
||||
contient toujours toutes les chaînes de caractère dont le bot a besoin.
|
||||
|
||||
La norme pour les nom dans les fichiers est la suivante :
|
||||
- Chaîne de charactère des commandes :
|
||||
`c` est utilisé pour `C`ommande.
|
||||
- `c_NOM-COMMANDE_name` : Nom de la commande
|
||||
- `c_NOM-COMMANDE_desc` : Description de la commande
|
||||
- `c_NOM-COMMANDE_optX_name` : Nom de l'option X
|
||||
- `c_NOM-COMMANDE_optX_desc` : Description de l'option X
|
||||
- `c_NOM-COMMANDEX` : `X` le numéro de la chaîne de caractère
|
||||
- Chaîne de charactère des évènements :
|
||||
`e` est utilisé pour `E`vènements.
|
||||
- `e_NOM-EVENEMENT_N` : `N` le nom de la chaîne de caractère
|
||||
- Chaîne de charactère des utils :
|
||||
`u` est utilisé pour `U`tilitaires.
|
||||
- `u_NOM-FICHIER-UTILS_N` : `N` le nom de la chaîne de caractère
|
||||
|
||||
### Ajouter une langue
|
||||
1. Créer un nouveau fichier dans [src/locales/](./src/locales/), le fichier
|
||||
|
@ -141,11 +155,14 @@ vos modifications dans ce dernier.
|
|||
Pour commencer, vous pouvez jeté un oeil aux
|
||||
[tickets facilement résolvable](https://git.kennel.ml/ConfrerieDuKassoulait/Botanique/issues?state=open&labels=82).
|
||||
|
||||
- De préférences, les fonctions, méthodes et variables seront écrites
|
||||
en anglais, ainsi que les commits afin que chacun puisse contribuer.
|
||||
|
||||
## Soumettre ses modifications
|
||||
1. Pensez à bien commenter votre code pour que n'importe qui comprennent vos
|
||||
modifications. Vérifier bien dans tout les fichiers si ce que vous avez
|
||||
modifié n'est pas référencer ailleurs (exemple : si vous modifier une variable
|
||||
d'environnement, il faut penser à mettre à jour le
|
||||
1. Pensez à bien commenter votre code (en anglais) pour que n'importe qui
|
||||
comprennent vos modifications. Vérifier bien dans tout les fichiers si ce que
|
||||
vous avez modifié n'est pas référencer ailleurs (exemple : si vous modifier
|
||||
une variable d'environnement, il faut penser à mettre à jour le
|
||||
[`README`](./README.md#variables-denvironnements)).
|
||||
|
||||
2. N'oubliez pas d'utiliser [les fichiers de langues](./src/locales/) pour vos
|
||||
|
|
Loading…
Reference in a new issue