Skip to content

Latest commit

 

History

History
48 lines (33 loc) · 1.84 KB

CONTRIBUTING.md

File metadata and controls

48 lines (33 loc) · 1.84 KB

Building

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).

Using in your project

The package is published to CHaP. 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.

Note that this project will be deprecated once WinIO is mature enough and thus it won't be published to hackage.

Code Style

Please follow local style. For a more detailed style guide see link.

Pull Requests

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.

If your pull requests resolves an existing issue, please link your PR to that issue, see [GitHub documentation][gh-link-issue].

Core Maintainers

Core maintainers are listed in the Win32-network.cabal file.