-
Notifications
You must be signed in to change notification settings - Fork 26
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Added contributing and updated readme.
- Loading branch information
Jan de Muijnck-Hughes
committed
Dec 2, 2013
1 parent
0002453
commit 08bf86b
Showing
2 changed files
with
21 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters