diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 00000000..8fb8a76d --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,57 @@ +# Cloud Haskell contributor guidelines + +## Building + +After cloning, you should be able to build all packages in this repository like so: + +``` +$ cabal build all +``` + +You can also build a specific package like so: + +``` +cabal build +``` + +You can have more control over the behavior of `cabal` by configuring, first. For example, if you want to disable optimizations for faster compilation: + +``` +$ cabal configure --disable-optimization +$ cabal build all +``` + +The allowed arguments for `cabal configure` are [documented here](https://cabal.readthedocs.io/en/stable/cabal-project-description-file.html#global-configuration-options). + +Tests for all packages can be run with: + +``` +$ cabal test all +``` + +or again, you can test a specific package `` using: + +``` +$ cabal test +``` + +### Building with specific dependencies + +Often, we want to build a package with a specific version of a dependency, for testing or debugging purposes. In this case, recall that you can always constrain cabal using the `--constraint` flag. For example, if I want to build `distributed-process-async` with `async==2.2.5`: + +``` +$ cabal build distributed-process-async --constraint="async==2.2.5" +``` + +## Contributing changes upstream + +To contribute changes, you first need a fork. First, fork the `distributed-process` repository following the [instructions here](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/working-with-forks/fork-a-repo). + +Then publish branches: + +``` +$ cabal test all # Check that everything works before proceeding. +$ git push --set-upstream +``` + +Then you can [create a pull-request](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request) to contribute changes back to `distributed-process`. diff --git a/packages/distributed-process-async/CONTRIBUTING.md b/packages/distributed-process-async/CONTRIBUTING.md deleted file mode 100644 index 7a4f3ee4..00000000 --- a/packages/distributed-process-async/CONTRIBUTING.md +++ /dev/null @@ -1 +0,0 @@ -See https://github.com/haskell-distributed/cloud-haskell/blob/master/CONTRIBUTING.md. diff --git a/packages/distributed-process-async/Setup.lhs b/packages/distributed-process-async/Setup.lhs deleted file mode 100644 index 5bde0de9..00000000 --- a/packages/distributed-process-async/Setup.lhs +++ /dev/null @@ -1,3 +0,0 @@ -#!/usr/bin/env runhaskell -> import Distribution.Simple -> main = defaultMain diff --git a/packages/distributed-process-client-server/Setup.lhs b/packages/distributed-process-client-server/Setup.lhs deleted file mode 100644 index 5bde0de9..00000000 --- a/packages/distributed-process-client-server/Setup.lhs +++ /dev/null @@ -1,3 +0,0 @@ -#!/usr/bin/env runhaskell -> import Distribution.Simple -> main = defaultMain diff --git a/packages/distributed-process-execution/Setup.lhs b/packages/distributed-process-execution/Setup.lhs deleted file mode 100644 index 5bde0de9..00000000 --- a/packages/distributed-process-execution/Setup.lhs +++ /dev/null @@ -1,3 +0,0 @@ -#!/usr/bin/env runhaskell -> import Distribution.Simple -> main = defaultMain diff --git a/packages/distributed-process-extras/Setup.lhs b/packages/distributed-process-extras/Setup.lhs deleted file mode 100644 index 5bde0de9..00000000 --- a/packages/distributed-process-extras/Setup.lhs +++ /dev/null @@ -1,3 +0,0 @@ -#!/usr/bin/env runhaskell -> import Distribution.Simple -> main = defaultMain diff --git a/packages/distributed-process-simplelocalnet/Setup.hs b/packages/distributed-process-simplelocalnet/Setup.hs deleted file mode 100644 index 9a994af6..00000000 --- a/packages/distributed-process-simplelocalnet/Setup.hs +++ /dev/null @@ -1,2 +0,0 @@ -import Distribution.Simple -main = defaultMain diff --git a/packages/distributed-process-supervisor/Setup.lhs b/packages/distributed-process-supervisor/Setup.lhs deleted file mode 100644 index 5bde0de9..00000000 --- a/packages/distributed-process-supervisor/Setup.lhs +++ /dev/null @@ -1,3 +0,0 @@ -#!/usr/bin/env runhaskell -> import Distribution.Simple -> main = defaultMain diff --git a/packages/distributed-process-systest/Setup.hs b/packages/distributed-process-systest/Setup.hs deleted file mode 100644 index 9a994af6..00000000 --- a/packages/distributed-process-systest/Setup.hs +++ /dev/null @@ -1,2 +0,0 @@ -import Distribution.Simple -main = defaultMain diff --git a/packages/distributed-process-tests/CONTRIBUTING.md b/packages/distributed-process-tests/CONTRIBUTING.md deleted file mode 100644 index 7a4f3ee4..00000000 --- a/packages/distributed-process-tests/CONTRIBUTING.md +++ /dev/null @@ -1 +0,0 @@ -See https://github.com/haskell-distributed/cloud-haskell/blob/master/CONTRIBUTING.md. diff --git a/packages/distributed-process-tests/README.md b/packages/distributed-process-tests/README.md deleted file mode 100644 index b625c591..00000000 --- a/packages/distributed-process-tests/README.md +++ /dev/null @@ -1,13 +0,0 @@ -# distributed-process-tests -[![Release](https://img.shields.io/hackage/v/distributed-process-tests.svg)](https://hackage.haskell.org/package/distributed-process-tests) - -See http://haskell-distributed.github.com for documentation, user guides, -tutorials and assistance. - -## Getting Help / Raising Issues - -Please visit the [bug tracker](https://github.com/haskell-distributed/distributed-process-tests/issues) to submit issues. You can contact the distributed-haskell@googlegroups.com mailing list for help and comments. - -## License - -This package is made available under a 3-clause BSD-style license. diff --git a/packages/distributed-process-tests/Setup.hs b/packages/distributed-process-tests/Setup.hs deleted file mode 100644 index 9a994af6..00000000 --- a/packages/distributed-process-tests/Setup.hs +++ /dev/null @@ -1,2 +0,0 @@ -import Distribution.Simple -main = defaultMain diff --git a/packages/distributed-process/CONTRIBUTING.md b/packages/distributed-process/CONTRIBUTING.md deleted file mode 100644 index 7a4f3ee4..00000000 --- a/packages/distributed-process/CONTRIBUTING.md +++ /dev/null @@ -1 +0,0 @@ -See https://github.com/haskell-distributed/cloud-haskell/blob/master/CONTRIBUTING.md. diff --git a/packages/distributed-static/Setup.hs b/packages/distributed-static/Setup.hs deleted file mode 100644 index 9a994af6..00000000 --- a/packages/distributed-static/Setup.hs +++ /dev/null @@ -1,2 +0,0 @@ -import Distribution.Simple -main = defaultMain diff --git a/packages/network-transport-inmemory/Setup.hs b/packages/network-transport-inmemory/Setup.hs deleted file mode 100644 index 9a994af6..00000000 --- a/packages/network-transport-inmemory/Setup.hs +++ /dev/null @@ -1,2 +0,0 @@ -import Distribution.Simple -main = defaultMain diff --git a/packages/network-transport-tcp/Setup.hs b/packages/network-transport-tcp/Setup.hs deleted file mode 100644 index 9a994af6..00000000 --- a/packages/network-transport-tcp/Setup.hs +++ /dev/null @@ -1,2 +0,0 @@ -import Distribution.Simple -main = defaultMain diff --git a/packages/network-transport/Setup.hs b/packages/network-transport/Setup.hs deleted file mode 100644 index 9a994af6..00000000 --- a/packages/network-transport/Setup.hs +++ /dev/null @@ -1,2 +0,0 @@ -import Distribution.Simple -main = defaultMain diff --git a/packages/rank1dynamic/Setup.hs b/packages/rank1dynamic/Setup.hs deleted file mode 100644 index 9a994af6..00000000 --- a/packages/rank1dynamic/Setup.hs +++ /dev/null @@ -1,2 +0,0 @@ -import Distribution.Simple -main = defaultMain