Skip to content

Commit

Permalink
[meta] Update CONTRIBUTING.md
Browse files Browse the repository at this point in the history
  • Loading branch information
tipsy authored Aug 13, 2018
1 parent 3869e32 commit f3e35fb
Showing 1 changed file with 6 additions and 6 deletions.
12 changes: 6 additions & 6 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,23 +1,23 @@
## How to contribute
# Contributing

### Creating an issue
## Creating an issue
Remember to include enough information if you're reporting a bug.
Creating an issue to ask a question is fine.

### Creating a PR
## Creating a PR
Every PR will be considered.

#### How to increase the chance of having your PR merged
### How to increase the chance of having your PR merged

* Ask about the feature beforehand (or pick one of the open issues)
* If no issue exists, create an issue for the PR
* Try to write some tests for your change. There are a lot of examples in the `test` dir.
* Format your code so it looks somewhat like the rest of the source (which is formatted using default settings in IntelliJ)

### How to run tests
## Runnning tests

`mvn test`

### How to install in local Maven repository for development testing
## Building project locally

`mvn install`

0 comments on commit f3e35fb

Please sign in to comment.