-
Notifications
You must be signed in to change notification settings - Fork 3
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
28 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,28 @@ | ||
Contributing to Feldspar | ||
--------------------- | ||
|
||
Start by reading [tibbe's style guide](https://github.com/tibbe/haskell-style-guide/blob/master/haskell-style.md). | ||
Current Feldspar follows most of the conventions except for the section on | ||
data types. | ||
|
||
Use your judgement. Having a line that is 83 characters long might be a better | ||
choice compared to the alternative even if it violates the style guide. | ||
|
||
1. No commits to master in your fork. | ||
|
||
1. Follow whatever code style the file uses. One consistent but bad | ||
style is preferable over having eight different good styles in the | ||
same file. | ||
|
||
1. No trailing whitespace. | ||
|
||
1. Run `cabal test` before committing. | ||
|
||
1. Use one commit per logical change. | ||
|
||
1. Keep the pile of small style fixes and similar in one or several | ||
separate commits. | ||
|
||
1. Make a sensible commit message. | ||
|
||
|