The project is build with cabal-install. You might need to run cabal update after cloning the repository (to update Cardano Haskell Packages (ChaP) index).
Currently the package is published to CHaP. In future it will be
published to Hackage. If you want to pull it from CHaP, this is
relatively easy to setup; for example, checkout the
cabal.project
file. Alternatively, you can relay on source-repository-package stanza in
a cabal.project file.
The typed-protocols-examples package contains two simple protocols PingPong
& ReqResp which are used for illustration & testing.
cabal run typed-protocols-examples:test
Please follow local style. For a more detailed style guide see link.
Each commit shall be small and preferably address one thing at a time. Well organised & documented commits make it much easier for the maintainers to review them.
New features should be well documented & tested, which means including new tests as necessary. You might be asked by the maintainers to write & include additional tests.
Each commit should build & test, at least the package you are changing. You can update other packages from this repository in a subsequent commit.
Please use a draft PRs if the work is still in progress.
We require all commits to be signed, see this guide.
If your pull requests resolves an existing issue, please link your PR to that issue, see GitHub documentation.