From 33de4fb4f4df5c6ad2dc0aab017abe5ff524cf69 Mon Sep 17 00:00:00 2001 From: Alistair McKinlay Date: Fri, 19 Jul 2019 11:30:43 +0100 Subject: [PATCH] Add prettier info to CONTRIBUTING.md --- .github/CONTRIBUTING.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index 62ac1fcd..4f18191e 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -31,3 +31,7 @@ your contributions. corner](https://github.com/thelounge/thelounge/wiki/Maintainers'-corner). - Please document any relevant changes in the documentation that can be found [in its own repository](https://github.com/thelounge/thelounge.chat). +- Note that we use prettier on the project. You can set up IDE plugins to format + on save ([see VS Code one here](https://marketplace.visualstudio.com/items?itemName=esbenp.prettier-vscode)). +- We have a git hook to automatically run prettier before commit, in case you don't install the plugin. +- If for any reason, prettier does not work for you, you can run `yarn format:prettier` and that should format everything.