Permalink
Browse files

Added a read-me file with instructions for contributing

  • Loading branch information...
1 parent a79f1ce commit 7292f91d6c5d77638e95920bd886a0987448583e @tibbe tibbe committed Dec 19, 2009
Showing with 62 additions and 0 deletions.
  1. +61 −0 README.md
  2. +1 −0 event.cabal
View
@@ -0,0 +1,61 @@
+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] [1].
+
+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] [2] 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.
+
+[1]: http://github.com/tibbe/haskell-style-guide
+[2]: http://www.tpope.net/node/106
View
@@ -12,6 +12,7 @@ category: System
build-type: Custom
cabal-version: >= 1.6
+extra-source-files: README.md
library
exposed-modules:

0 comments on commit 7292f91

Please sign in to comment.