diff options
| author | Albert Krewinkel <tarleb@moltkeplatz.de> | 2014-04-09 15:45:08 +0200 |
|---|---|---|
| committer | Albert Krewinkel <tarleb@moltkeplatz.de> | 2014-04-09 16:11:14 +0200 |
| commit | 5b9f9047a02f96daf5215bfd4d1cd376ef4186c3 (patch) | |
| tree | 9d5665dd5fc61bf1c1c10b224584107287e2b776 | |
| parent | e555a5703d4581f11c6b5020811bf60b5ec98c41 (diff) | |
| download | pandoc-5b9f9047a02f96daf5215bfd4d1cd376ef4186c3.tar.gz | |
Add .editorconfig
Use EditorConfig to define a some basic styling rules for code. This
should also help to reduce the number of commits introducing trailing
whitespace.
See http://editorconfig.org/ for details.
| -rw-r--r-- | .editorconfig | 12 | ||||
| -rw-r--r-- | CONTRIBUTING.md | 3 |
2 files changed, 15 insertions, 0 deletions
diff --git a/.editorconfig b/.editorconfig new file mode 100644 index 000000000..9c562bd1f --- /dev/null +++ b/.editorconfig @@ -0,0 +1,12 @@ +root = true + +[*] +charset = utf-8 +end_of_line = lf +indent_style = space +indent_size = 2 +insert_final_newline = true +trim_trailing_whitespace = true + +[*.{markdown,md}] +trim_trailing_whitespace = false diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index eeee77b25..824d1465e 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -60,6 +60,8 @@ Please follow these guidelines: 3. Follow the stylistic conventions you find in the existing pandoc code. Use spaces, not tabs, and wrap code to 80 columns. Always include type signatures for top-level functions. + Consider installing [EditorConfig], this will help you to follow the + coding style prevalent in pandoc. 4. Your code should compile without warnings (`-Wall` clean). @@ -177,5 +179,6 @@ The library is structured as follows: [issue tracker]: https://github.com/jgm/pandoc/issues [User's Guide]: http://johnmacfarlane.net/pandoc/README.html [FAQs]: http://johnmacfarlane.net/pandoc/faqs.html +[EditorConfig]: http://editorconfig.org/ [Haskell platform]: http://www.haskell.org/platform/ [hsb2hs]: http://hackage.haskell.org/package/hsb2hs |