[commit: packages/hoopl] master, pr/coverage: Update README with the style guide information (218c272)

git at git.haskell.org git at git.haskell.org
Mon Apr 17 21:37:26 UTC 2017


Repository : ssh://git@git.haskell.org/hoopl

On branches: master,pr/coverage
Link       : http://git.haskell.org/packages/hoopl.git/commitdiff/218c27269422501afa1db2c4b4941b37d85e08a0

>---------------------------------------------------------------

commit 218c27269422501afa1db2c4b4941b37d85e08a0
Author: Michal Terepeta <michal.terepeta at gmail.com>
Date:   Sun Jan 24 15:44:32 2016 +0100

    Update README with the style guide information
    
    As decided in #24 let's follow tibbe's style for all new or modified
    code.  Hopefully, with time, we'll end up with code that's a bit more
    pleasant to read.


>---------------------------------------------------------------

218c27269422501afa1db2c4b4941b37d85e08a0
 README.md | 8 ++++++++
 1 file changed, 8 insertions(+)

diff --git a/README.md b/README.md
index e7b0cda..0004a3c 100644
--- a/README.md
+++ b/README.md
@@ -16,6 +16,8 @@ Transformation"](http://research.microsoft.com/en-us/um/people/simonpj/Papers/c-
 
 ### Development Notes
 
+#### Building and testing
+
 To build the library run:
 
     cabal configure
@@ -35,6 +37,12 @@ To run the tests with the test coverage report run:
 You'll need a Haskell Platform, which should include appropriate
 versions of Cabal and GHC.
 
+#### Coding style
+
+Please follow Johan Tibell's
+[Haskell Style Guide](https://github.com/tibbe/haskell-style-guide/blob/master/haskell-style.md)
+for all new/modified code.
+
 ### Checklist for Making Releases
 
 In order to facilitate GHC development's workflow, the version in [`hoopl.cabal`](hoopl.cabal) is to be bumped as soon as a change requires a respective version bump (according to the PVP) relative to the last released `hoopl` version.



More information about the ghc-commits mailing list