diff --git a/README.md b/README.md index f78b602..6a36e84 100644 --- a/README.md +++ b/README.md @@ -122,7 +122,15 @@ In case you need to upload your logs somewhere, be aware that they contain your ``| sed -r 's/[0-9]{10,}/📞/g' `` * "Mautrix-WhatsApp" bridge is based on the [Rhymen/go-whatsapp](https://github.com/Rhymen/go-whatsapp) implementation of the [sigalor/whatsapp-web-reveng](https://github.com/sigalor/whatsapp-web-reveng) project. +## 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: diff --git a/README_fr.md b/README_fr.md index a1b2266..851ffbb 100644 --- a/README_fr.md +++ b/README_fr.md @@ -105,6 +105,16 @@ Si vous devez téléverser vos fichiers log quelque-part, soyez avertis qu'ils c ``| sed -r 's/[0-9]{10,}/📞/g' `` * La passerelle "Mautrix-WhatsApp" repose sur l'implémentation [Rhymen/go-whatsapp](https://github.com/Rhymen/go-whatsapp) du projet [sigalor/whatsapp-web-reveng](https://github.com/sigalor/whatsapp-web-reveng). +## 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 :