Skip to content

Commit 58447ec

Browse files
authored
Include .editorconfig in the contributing section
1 parent b43a8cd commit 58447ec

File tree

1 file changed

+7
-0
lines changed

1 file changed

+7
-0
lines changed

README.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -552,6 +552,13 @@ This returns an error in HLS if 'tasty-discover' is not in the path: `could not
552552
- Join [our IRC channel](https://webchat.freenode.net/?channels=haskell-ide-engine) at `#haskell-ide-engine` on `freenode`.
553553
- Fork this repo and [ghcide](https://github.com/haskell/ghcide) and hack as much as you can.
554554

555+
### Style guidelines
556+
557+
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.
558+
However, most editors will need some action to honour those settings automatically.
559+
For example vscode needs to have installed a specific [extension](https://marketplace.visualstudio.com/items?itemName=EditorConfig.EditorConfig).
560+
Please, try to follow those basic settings to keep the codebase as uniform as possible.
561+
555562
### Building haskell-language-server
556563

557564
The project can be built with both `cabal build` and `stack build`.

0 commit comments

Comments
 (0)