Skip to content

Latest commit

 

History

History
34 lines (26 loc) · 1.34 KB

CONTRIBUTING.md

File metadata and controls

34 lines (26 loc) · 1.34 KB
Raw

Generally, Finch follows a standard fork and pull model for contributions via GitHub pull requests. Thus, the contributing process looks as follows:

  1. Write code
  2. Write tests
  3. Write docs
  4. Submit a PR

Write Code

Finch follows the Effective Scala 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 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-123")
  • 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%
  • PR's commit message should use present tense and be capitalized properly (i.e., Fix #123: Add tests for RequestReader)