-
Notifications
You must be signed in to change notification settings - Fork 221
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
1 parent
6fd9825
commit d1bec6d
Showing
2 changed files
with
44 additions
and
1 deletion.
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,33 @@ | ||
Generally, Finch follows a standard [fork and pull][0] model for contributions via GitHub pull requests. Thus, the | ||
_contributing process_ looks as follows: | ||
|
||
1. [Write code](#write-code) | ||
2. [Write tests](#write-tests) | ||
3. [Write docs](#write-docs) | ||
4. [Submit a PR](#submit-a-pr) | ||
|
||
## Write Code | ||
Finch follows [Effective Scala][1] code style guide. When in doubt, look around the codebase and see how it's done elsewhere. | ||
|
||
* Code and comments should be formatted to a width no greater than 120 columns | ||
* Files should be exempt of trailing spaces | ||
|
||
## Write Tests | ||
Finch uses [ScalaTest][2] with the following settings: | ||
|
||
* Every test should be a `FlatSpec` with `Matchers` mixed in | ||
* An assertion should be done with `x shouldBe y` | ||
* Exceptions should be intercepted with `an [Exception] should be thrownBy x` | ||
|
||
## Write Docs | ||
Write clean and simple docs in the `docs.md` file. | ||
|
||
## Submit a PR | ||
|
||
* PR should be submitted from a separate branch (use `git checkout -b "fix-133"`) | ||
* PR should contain only one commit (use `git commit --amend` and `git --force push`) | ||
* PR should not decrease the code coverage more than by 1% | ||
|
||
[0]: https://help.github.com/articles/using-pull-requests/ | ||
[1]: http://twitter.github.io/effectivescala/ | ||
[2]: http://www.scalatest.org/ |
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