Skip to content

Commit 5d08b8f

Browse files
committed
Add contributing file. Checkstyle is now written to stdout.
1 parent 1551175 commit 5d08b8f

File tree

2 files changed

+16
-1
lines changed

2 files changed

+16
-1
lines changed

CONTRIBUTING.md

+15
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
Contributing
2+
============
3+
4+
If you would like to contribute code to Spoon you can do so through GitHub by
5+
forking the repository and sending a pull request.
6+
7+
When submitting code, please make every effort to follow existing conventions
8+
and style in order to keep the code as readable as possible. Please also make
9+
sure your code compiles by running `mvn clean verify`.
10+
11+
Before your code can be accepted into the project you must also sign the
12+
[Individual Contributor License Agreement (CLA)][1].
13+
14+
15+
[1]: https://spreadsheets.google.com/spreadsheet/viewform?formkey=dDViT2xzUHAwRkI3X3k5Z0lQM091OGc6MQ&ndplr=1

website/index.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -97,7 +97,7 @@ <h4 id="maven">Maven</h4>
9797

9898
<h3 id="contributing">Contributing</h3>
9999
<p>If you would like to contribute code to Spoon you can do so through GitHub by forking the repository and sending a pull request.</p>
100-
<p>When submitting code, please make every effort to follow existing conventions and style in order to keep the code as readable as possible. Please also make sure your code compiles by running <code>mvn clean verify</code>. Checkstyle failures during compilation indicate errors in your style and can be viewed in the <code>checkstyle-result.xml</code> file.</p>
100+
<p>When submitting code, please make every effort to follow existing conventions and style in order to keep the code as readable as possible. Please also make sure your code compiles by running <code>mvn clean verify</code>.
101101
<p>Before your code can be accepted into the project you must also sign the <a href="https://spreadsheets.google.com/spreadsheet/viewform?formkey=dDViT2xzUHAwRkI3X3k5Z0lQM091OGc6MQ&ndplr=1">Individual Contributor License Agreement (CLA)</a>.</p>
102102

103103
<h3 id="license">License</h3>

0 commit comments

Comments
 (0)