Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Newer
Older
100644 73 lines (47 sloc) 2.0 kb
7292f91 @tibbe Added a read-me file with instructions for contributing
tibbe authored
1 Scalable event notification
2 ===========================
3
4 The event library provides scalable event notification for file
5 handles, sockets, timers, etc.
6
7 Contributing
8 ------------
9
10 ### Prerequisites
11
12 Make sure you read the [Haskell Style Guide] [1].
13
14 The existing code doesn't follow the style guide fully but you should
15 follow it for all new code.
16
17 ### Creating patches
18
19 The preferred way of contributing changes to the project is to use Git
20 and send the patches over email using the Git commands `format-patch`
21 and `send-email`. Step by step instructions:
22
23 Clone the repository:
24
25 git clone http://github.com/tibbe/event
26
27 Make your changes:
28
29 cd event
30 $EDITOR <file>
31
32 Commit your changes in one or more commits:
33
34 git add <file>
35 git commit
36
37 Make sure you write a good commit message. Commit messages should
38 contain a short summary on a separate line and, if needed, a more
39 thorough explanation of the change. Write full sentences and use
40 proper spelling, punctuation, and grammar. See
41 [A Note About Git Commit Messages] [2] for more information.
42
43 You might want to use `git rebase` to make sure your commits
44 correspond to nice, logical commits. Make sure whitespace only
45 changes are kept in separate commits to ease reviewing.
46
47 Prepare the e.g. last five patches for sending:
48
49 git format-patch -5 -n
50
51 This will create one patch file per patch.
52
53 git send-email --to <maintainer> <patch files>
54
55 The maintainer is specified in the Cabal file. The maintainer will
56 review your changes and may ask you to make changes to them. Make the
57 changes to your local repository and use `git rebase` to massage them
58 into nice, logical commits and resend the patches.
59
5da2815 @tibbe Added instructions for running the unit tests
tibbe authored
60 Running the tests
61 -----------------
62
63 You can run all unit tests by first building the "test" executable and
64 then running `cabal test`:
65
66 cabal clean && cabal configure -ftest && cabal build && cabal test
67
68 References
69 ----------
70
7292f91 @tibbe Added a read-me file with instructions for contributing
tibbe authored
71 [1]: http://github.com/tibbe/haskell-style-guide
72 [2]: http://www.tpope.net/node/106
Something went wrong with that request. Please try again.