Skip to content

Commit

Permalink
Improve documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
jaguililla committed Aug 29, 2018
1 parent 96f52d3 commit bbca5f8
Showing 1 changed file with 3 additions and 1 deletion.
4 changes: 3 additions & 1 deletion contributing.md
Expand Up @@ -93,6 +93,8 @@ The benchmark are the same run inside [TechEmpower Framework Benchmarks][TFB], t
- It should be done to the `develop` branch.
- The code has to pass all PR checks.
- All public methods and field must be documented using [Dokka](https://github.com/Kotlin/dokka).
- The code should follow the [Kotlin Coding Conventions]. With the exception of final brace
position in `else`, `catch` and `finally` (in its own line).

* Commit format: the preferred commit format would have:
- Summary: small summary of the change. In imperative form.
Expand All @@ -116,8 +118,8 @@ The benchmark are the same run inside [TechEmpower Framework Benchmarks][TFB], t
Then something happened
And I expected this other thing
```

[Quick Start]: http://hexagonkt.com/quick_start.html
[Kotlin Coding Conventions]: https://kotlinlang.org/docs/reference/coding-conventions.html

## Tasks and Milestones

Expand Down

0 comments on commit bbca5f8

Please sign in to comment.