Browse files

Add code convention housekeeping guidleines

  • Loading branch information...
1 parent a8425de commit 9112c8de676d3c3fc27d4fbf60bba53ddfdc62e6 @dsyer dsyer committed Nov 30, 2010
Showing with 288 additions and 0 deletions.
  1. +9 −0
  2. +279 −0 eclipse-code-formatter.xml
@@ -19,3 +19,12 @@ Here are some ways for you to get involved in the community:
* Watch for upcoming articles on Spring by [subscribing]( to
Before we accept a non-trivial patch or pull request we will need you to sign the [contributor's agreement]( Signing the contributor's agreement does not grant anyone commit rights to the main repository, but it does mean that we can accept your contributions, and you will get an author credit if we do. Active contributors might be asked to join the core team, and given the ability to merge pull requests.
+## Code Conventions and Housekeeping
+None of these is essential for a pull request, but they will all help. They can also be added after the original pull request but before a merge.
+* Use the Spring Framework code format conventions (import `eclipse-code-formatter.xml` from the root of the project if you are using Eclipse).
+* Make sure all new .java files to have a simple Javadoc class comment with at least an @author tag identifying you, and preferably at least a paragraph on what the class is for.
+* Add the ASF license header comment to all new .java files (copy from existing files in the project)
+* Add yourself as an @author to the .java files that you modify substantially (moew than cosmetic changes).
+* Add some Javadocs and, if you change the namespace, some XSD doc elements (Spring AMQP is not stellar in this area yet, but it will have to come up to scratch one day, so you will be helping a lot).
+* A few unit tests would help a lot as well - someone has to do it.
Oops, something went wrong.

0 comments on commit 9112c8d

Please sign in to comment.