-
Notifications
You must be signed in to change notification settings - Fork 34
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
2f0f617
commit 99b8dd0
Showing
1 changed file
with
25 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,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! |