Skip to content

Commit f220073

Browse files
committed
Encourage mvn clean verify use
1 parent 80e71da commit f220073

File tree

1 file changed

+13
-27
lines changed

1 file changed

+13
-27
lines changed

CONTRIBUTING.md

Lines changed: 13 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -2,30 +2,16 @@
22

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

5-
For small changes, please simply submit a
6-
[pull request](https://github.com/lmdbjava/lmdbjava/pulls).
7-
8-
For larger changes, please
9-
[open a GitHub issue](https://github.com/lmdbjava/lmdbjava/issues) first so that
10-
we can discuss what you have in mind.
11-
12-
## Priorities
13-
14-
All engineering decisions require trade-offs, which is why we have an ordered list of
15-
[priorites](https://github.com/lmdbjava/lmdbjava/blob/master/src/main/java/org/lmdbjava/package-info.java).
16-
Please ensure your changes reflect those priorities.
17-
18-
## Style
19-
20-
Please use the current code as your style guide and run `mvn clean verify`
21-
before submitting a pull request. This will execute Maven checks using PMD,
22-
FindBugs, Checkstyle, XML Formatting, classpath duplication, dependency usage,
23-
and dependency versioning plugins.
24-
25-
## Questions
26-
27-
If you have any questions, please
28-
[open a GitHub issue](https://github.com/lmdbjava/lmdbjava/issues) and we'll be
29-
pleased to help.
30-
31-
Thanks for your interest in contributing!
5+
**Before submitting a PR, please run `mvn clean verify`**.
6+
This will run:
7+
8+
* Tests
9+
* Initial Test Coverage
10+
* Checkstyle
11+
* PMD
12+
* FindBugs
13+
* XML Formatting
14+
* License Header Management
15+
16+
`mvn clean verify` is also run by CI, but it's quicker and easier to run
17+
before submitting.

0 commit comments

Comments
 (0)