diff --git a/README.md b/README.md index 00b094e..cd5ecb8 100644 --- a/README.md +++ b/README.md @@ -97,6 +97,16 @@ ExecStartPre=/bin/sleep 90 such that it is ensured that synapse is running before the bridge tries to connect. (If it worked after installation but broke after a restart this probably is it.) +## Development code quality + +The `.github/workflows/updater.sh` script needs to be synced with changes in `conf/config.yaml` therefore a `pre-commit` +hook is used to display a reminder to update `.github/workflows/updater.sh` (if needed) when `conf/config.yaml` has been modified. + +Please enable Git hooks using following command to ensure code quality and stability. +``` bash +git config --local core.hooksPath .githooks +``` + ## Documentation and resources * Official app website: @@ -118,12 +128,4 @@ or sudo yunohost app upgrade mautrix_telegram -u https://github.com/YunoHost-Apps/mautrix_telegram_ynh/tree/testing --debug ``` -The `.github/workflows/updater.sh` script needs to be synced with changes in `conf/config.yaml` so for now a `pre-commit` -hook is used to display a reminder to update `.github/workflows/updater.sh` (if needed) when `conf/config.yaml` has been modified. - -Please enable Git hooks using following command to ensure code quality and stability. -``` bash -git config --local core.hooksPath .githooks -``` - **More info regarding app packaging:** diff --git a/README_fr.md b/README_fr.md index 829397f..a43d9aa 100644 --- a/README_fr.md +++ b/README_fr.md @@ -92,6 +92,17 @@ ExecStartPre=/bin/sleep 90 such that it is ensured that synapse is running before the bridge tries to connect. (If it worked after installation but broke after a restart this probably is it.) +## Development code quality + +Le script `.github/workflows/updater.sh` doit être synchronisé avec les changements dans `conf/config.yaml`, +donc un hook `pre-commit` est utilisé pour afficher un rappel pour mettre à jour +`.github/workflows/updater.sh` (si nécessaire) lorsque `conf/config.yaml` a été modifié. + +Veuillez activer les hooks Git en utilisant la commande suivante pour assurer la qualité et la stabilité du code. +``` bash +git config --local core.hooksPath .githooks +``` + ## Documentations et ressources * Site officiel de l'app : @@ -113,10 +124,4 @@ ou sudo yunohost app upgrade mautrix_telegram -u https://github.com/YunoHost-Apps/mautrix_telegram_ynh/tree/testing --debug ``` -Le script `.github/workflows/updater.sh` doit être synchronisé avec les changements dans `conf/config.yaml`, -donc pour l'instant un hook `pre-commit` est utilisé pour afficher un rappel pour mettre à jour -`.github/workflows/updater.sh` (si nécessaire) lorsque `conf/config.yaml` a été modifié. - -Veuillez activer les hooks Git en utilisant la commande suivante pour assurer la qualité et la stabilité du code. - **Plus d'infos sur le packaging d'applications :**