[tor-bugs] #18733 [Metrics/CollecTor]: contributor's guide incl. coding guidelines for java projects

[Tor Bug Tracker & Wiki]

#18733: contributor's guide incl. coding guidelines for java projects
-------------------------------+--------------------------
 Reporter:  iwakeh             |          Owner:  iwakeh
     Type:  task               |         Status:  assigned
 Priority:  Medium             |      Milestone:
Component:  Metrics/CollecTor  |        Version:
 Severity:  Normal             |     Resolution:
 Keywords:  ctip               |  Actual Points:
Parent ID:  #18730             |         Points:
 Reviewer:                     |        Sponsor:
-------------------------------+--------------------------

Comment (by iwakeh):

 A common file structure for java projects should be part of the
 contributor's guide.

 Suggestion (adapted from [https://maven.apache.org/guides/introduction
 /introduction-to-the-standard-directory-layout.html Maven's standard
 structure]):

 {{{
 #!html
 <table border="1" class="table table-striped">
 <tr>
 <td align="left"><tt>src/main/java</tt></td>
 <td align="left">Application/Library sources</td></tr>
 <tr>
 <td align="left"><tt>src/main/resources</tt></td>
 <td align="left">Application/Library resources</td></tr>
 <tr>
 <td align="left"><tt>src/main/webapp</tt></td>
 <td align="left">Web application sources</td></tr>
 <tr>
 <td align="left"><tt>src/test/java</tt></td>
 <td align="left">Test sources</td></tr>
 <tr>
 <td align="left"><tt>src/test/resources</tt></td>
 <td align="left">Test resources</td></tr>
 <tr>
 <td align="left"><tt>generated</tt></td>
 <td align="left">all test-reports; classes etc. in subfolders, if
 necessary</td></tr>
 <tr>
 <td align="left"><tt>generated/classes</tt></td>
 <td align="left">compiled classes</td></tr>
 <tr>
 <td align="left"><tt>generated/testclasses</tt></td>
 <td align="left">compiled test classes</td></tr>
 <tr>
 <td align="left"><tt>generated/test-results</tt></td>
 <td align="left">unit test results</td></tr>
 <tr>
 <td align="left"><tt>generated/instrument</tt></td>
 <td align="left">classes instrumented by cobertura</td></tr>
 <tr>
 <td align="left"><tt>generated/javadoc</tt></td>
 <td align="left">javadoc</td></tr>
 </table>

 }}}

 The top-level should hold license, readme, and build.xml.

--
Ticket URL: <https://trac.torproject.org/projects/tor/ticket/18733#comment:10>
Tor Bug Tracker & Wiki <https://trac.torproject.org/>
The Tor Project: anonymity online