Create CONTRIBUTING.md (#455)
authorMatt Renaud <matt@m-renaud.com>
Wed, 20 Dec 2017 22:37:40 +0000 (14:37 -0800)
committerDavid Feuer <David.Feuer@gmail.com>
Wed, 20 Dec 2017 22:37:40 +0000 (17:37 -0500)
Create CONTRIBUTING.md

CONTRIBUTING.md [new file with mode: 0644]

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
new file mode 100644 (file)
index 0000000..d09ec3d
--- /dev/null
@@ -0,0 +1,37 @@
+# Instructions for Contributors
+
+As mentioned in the [README](https://github.com/haskell/containers/blob/master/README.md), for reporting bugs (and maybe even the respective fix), please use the [GitHub issue tracker](https://github.com/haskell/containers/issues).
+
+For proposing API changes/enhancements, please follow the [guidelines outlined on the Haskell Wiki](https://wiki.haskell.org/Library_submissions#Guide_to_proposers). Especially note that all API changes/enhancements should be discussed on libraries@haskell.org mailing list.
+
+## Building and testing
+
+Building and testing the containers package can be done using either `cabal-install` or `stack`.
+
+### With cabal-install
+
+```
+cabal sandbox init
+cabal install --only-dependencies
+cabal install 'test-framework >= 0.3.3' 'test-framework-quickcheck2 >= 0.2.9' 'QuickCheck >= 2.4.0.1' 'ChasingBottoms' 'HUnit' 'test-framework-hunit'
+cabal configure -v2 --enable-tests
+cabal build
+cabal test
+```
+
+### With [Stack](https://docs.haskellstack.org/en/stable/README/)
+
+```
+stack init   # If you haven't previously initialized stack
+stack build
+stack test
+```
+
+## Troubleshooting
+
+- If you're using Stack, make sure you have version >= 1.6.1 ([1], [2])
+
+
+[1] https://github.com/commercialhaskell/stack/issues/3624
+
+[2] https://github.com/commercialhaskell/stack/issues/3345