Skip to content

Commit

Permalink
Added contributing and updated readme.
Browse files Browse the repository at this point in the history
  • Loading branch information
Jan de Muijnck-Hughes committed Dec 2, 2013
1 parent 0002453 commit 08bf86b
Show file tree
Hide file tree
Showing 2 changed files with 21 additions and 0 deletions.
19 changes: 19 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
# Contributing to 'Idris Koans'

## Rules

* Please aim to make commits self contained. Ideally one thing at a time.
* Commit messages should have a brief (less than 73 characters) leading sentence. Together with a more detailed description where appropriate.

## Dev Process

For developing the project, we aim to follow the following [Git Branching Model](http://nvie.com/posts/a-successful-git-branching-model).
In this model there are two main branches:

* **master** Reflects the _current_ version of the tutorial inline with the _current_ version of Idris on Hackage.
* **dev** Reflects the latest upstream and current state of the tutorial.

All pull requests that are for new additions to the project should go to **dev**
All pull requests that detail fixes to the tutorial that is: grammar, spelling, and coding mistakes should be submitted to **master**

This might sound complicated but in the long term it makes sense in terms of release management.
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,8 @@ The files should be attempted in the following order:
1. 06-ListComprehensions.idr

Idris Koans is in early development and so the list of Koans and method of interaction is primitive.
If you would like to contribute please feel free to do so.
However, please read [CONTRIBUTING.md] first.
We advised the best way to attempt each Koan is to edit the Koan file in your favourite editor, and compile each Koan in the terminal using the Idris compiler.
In future a more interactive environment may be planned.
Either a CLI/REPL environment _a la_ [Clojure Koans](http://clojurekoans.com/), or Web Based _a la_ [Clojurescript Koans](http://clojurescriptkoans.com/) may be added.
Expand Down

0 comments on commit 08bf86b

Please sign in to comment.