Skip to content

Commit

Permalink
Create CONTRIBUTING.md
Browse files Browse the repository at this point in the history
  • Loading branch information
chrisengelsma committed May 30, 2017
1 parent 2f0f617 commit 99b8dd0
Showing 1 changed file with 25 additions and 0 deletions.
25 changes: 25 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
# How to contribute

Thank you for reading this, we are always in need of volunteer developers to help this project remain strong.

## Testing

We require that all new submitted code be thoroughly tested.

Code submitted without any unit testing will be rejected. To run the test coverage locally, run ```gradle jacocoReport``` and review the results in build/reports/jacoco

## Submitting changes

Please send a [GitHub Pull Request to MinesJTK/jtk](https://github.com/MinesJTK/jtk/pull/new/master) with a clear list of what you've done.

## Coding conventions

Start reading our code and you'll get the hang of it. We optimize for readability:

* We indent using two (2) spaces (soft tabs)
* We always line break if the code exceeds 78 columns in width.
* We document every public and protected method using official javadoc documentation.
* We use standard camelCase nomenclature for methods and variables, no under_scoring.
* This is open source software. Consider the people who will read your code and make it legible for them.

Thank you!

0 comments on commit 99b8dd0

Please sign in to comment.