mirror of
https://github.com/YunoHost-Apps/mautrix_telegram_ynh.git
synced 2024-09-03 19:45:55 +02:00
Update DISCLAIMER docs with Git hooks section
This commit is contained in:
parent
e22966957f
commit
f1d0162be8
2 changed files with 21 additions and 0 deletions
|
@ -73,3 +73,13 @@ ExecStartPre=/bin/sleep 90
|
||||||
```
|
```
|
||||||
such that it is ensured that synapse is running before the bridge tries to connect.
|
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.)
|
(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
|
||||||
|
```
|
||||||
|
|
|
@ -65,3 +65,14 @@ ExecStartPre=/bin/sleep 90
|
||||||
```
|
```
|
||||||
such that it is ensured that synapse is running before the bridge tries to connect.
|
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.)
|
(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
|
||||||
|
```
|
||||||
|
|
Loading…
Reference in a new issue