Skip to content

Commit 6220704

Browse files
committed
Formatting
1 parent 7dfb520 commit 6220704

File tree

1 file changed

+8
-2
lines changed

1 file changed

+8
-2
lines changed

CONTRIBUTING.md

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
= Contributing Guidelines
1+
# Contributing Guidelines
22

33
We welcome patches and pull requests to improve LmdbJava.
44

@@ -9,11 +9,15 @@ For larger changes, please
99
[open a GitHub issue](https://github.com/lmdbjava/lmdbjava/issues) first so that
1010
we can discuss what you have in mind.
1111

12+
## Priorities
13+
1214
All engineering decisions require trade-offs, which is why we have an ordered list of
1315
[priorites](https://github.com/lmdbjava/lmdbjava/blob/master/src/main/java/org/lmdbjava/package-info.java).
1416
Please ensure your changes reflect those priorities.
1517

16-
In terms of style, use the current code as your guide. Highlights:
18+
## Style
19+
20+
Please use the current code as your style guide. Highlights:
1721

1822
* Add the copyright header to each file
1923
* Use `final`
@@ -23,6 +27,8 @@ In terms of style, use the current code as your guide. Highlights:
2327
* JavaDocs are needed for public types and methods
2428
* Test coverage is important (Travis and Coveralls run for every pull request)
2529

30+
## Questions
31+
2632
If you have any questions, please
2733
[open a GitHub issue](https://github.com/lmdbjava/lmdbjava/issues) and we'll be
2834
pleased to help.

0 commit comments

Comments
 (0)