Skip to content

Commit e8c02fe

Browse files
authored
Merge pull request #420 from haskell/jneira-readme-editorconfig
Include .editorconfig in the contributing section
2 parents 043abcb + 58447ec commit e8c02fe

File tree

1 file changed

+7
-0
lines changed

1 file changed

+7
-0
lines changed

README.md

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

564+
### Style guidelines
565+
566+
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.
567+
However, most editors will need some action to honour those settings automatically.
568+
For example vscode needs to have installed a specific [extension](https://marketplace.visualstudio.com/items?itemName=EditorConfig.EditorConfig).
569+
Please, try to follow those basic settings to keep the codebase as uniform as possible.
570+
564571
### Building haskell-language-server
565572

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

0 commit comments

Comments
 (0)