From 58447ecd92fd59d2033ecfd7521b62bf36693805 Mon Sep 17 00:00:00 2001 From: Javier Neira Date: Tue, 22 Sep 2020 12:23:00 +0200 Subject: [PATCH] Include .editorconfig in the contributing section --- README.md | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/README.md b/README.md index 6bead86b63..9434a78908 100644 --- a/README.md +++ b/README.md @@ -552,6 +552,13 @@ This returns an error in HLS if 'tasty-discover' is not in the path: `could not - Join [our IRC channel](https://webchat.freenode.net/?channels=haskell-ide-engine) at `#haskell-ide-engine` on `freenode`. - Fork this repo and [ghcide](https://github.com/haskell/ghcide) and hack as much as you can. +### Style guidelines + +The project includes a [`.editorconfig`](https://editorconfig.org) [file](https://github.com/haskell/haskell-language-server/blob/master/.editorconfig) with the editor basic settings used by the project. +However, most editors will need some action to honour those settings automatically. +For example vscode needs to have installed a specific [extension](https://marketplace.visualstudio.com/items?itemName=EditorConfig.EditorConfig). +Please, try to follow those basic settings to keep the codebase as uniform as possible. + ### Building haskell-language-server The project can be built with both `cabal build` and `stack build`.