Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP

A Haskell event notification library

tree: ca70603599

Fetching latest commit…

Cannot retrieve the latest commit at this time

README.md

Scalable event notification

The event library provides scalable event notification for file handles, sockets, timers, etc.

Contributing

Prerequisites

Make sure you read the Haskell Style Guide.

The existing code doesn't follow the style guide fully but you should follow it for all new code.

Creating patches

The preferred way of contributing changes to the project is to use Git and send the patches over email using the Git commands format-patch and send-email. Step by step instructions:

Clone the repository:

git clone http://github.com/tibbe/event

Make your changes:

cd event
$EDITOR <file>

Commit your changes in one or more commits:

git add <file>
git commit

Make sure you write a good commit message. Commit messages should contain a short summary on a separate line and, if needed, a more thorough explanation of the change. Write full sentences and use proper spelling, punctuation, and grammar. See A Note About Git Commit Messages for more information.

You might want to use git rebase to make sure your commits correspond to nice, logical commits. Make sure whitespace only changes are kept in separate commits to ease reviewing.

Prepare the e.g. last five patches for sending:

git format-patch -5 -n

This will create one patch file per patch.

git send-email --to <maintainer> <patch files>

The maintainer is specified in the Cabal file. The maintainer will review your changes and may ask you to make changes to them. Make the changes to your local repository and use git rebase to massage them into nice, logical commits and resend the patches.

Running the tests

You can run all unit tests by first building the "test" executable and then running cabal test:

cabal clean && cabal configure -ftest && cabal build && cabal test

References

Something went wrong with that request. Please try again.