diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..b022435 --- /dev/null +++ b/CONTRIBUTING.md @@ -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. diff --git a/README.md b/README.md index 7b76714..512717c 100644 --- a/README.md +++ b/README.md @@ -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.