svn commit: r1139545 - /incubator/airavata/site/trunk/content/airavata/source

[sm...@apache.org]

Author: smarru
Date: Sat Jun 25 14:36:47 2011
New Revision: 1139545

URL: http://svn.apache.org/viewvc?rev=1139545&view=rev
Log:
Adding source & developers guide

Added:
    incubator/airavata/site/trunk/content/airavata/source

Added: incubator/airavata/site/trunk/content/airavata/source
URL: http://svn.apache.org/viewvc/incubator/airavata/site/trunk/content/airavata/source?rev=1139545&view=auto
==============================================================================
--- incubator/airavata/site/trunk/content/airavata/source (added)
+++ incubator/airavata/site/trunk/content/airavata/source Sat Jun 25 14:36:47 2011
@@ -0,0 +1,59 @@
+Title: Airavata Source Code & Developers Guide
+Notice:    Licensed to the Apache Software Foundation (ASF) under one
+           or more contributor license agreements.  See the NOTICE file
+           distributed with this work for additional information
+           regarding copyright ownership.  The ASF licenses this file
+           to you under the Apache License, Version 2.0 (the
+           "License"); you may not use this file except in compliance
+           with the License.  You may obtain a copy of the License at
+           .
+             http://www.apache.org/licenses/LICENSE-2.0
+           .
+           Unless required by applicable law or agreed to in writing,
+           software distributed under the License is distributed on an
+           "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+           KIND, either express or implied.  See the License for the
+           specific language governing permissions and limitations
+           under the License.
+
+Airavata source code is maintained using [Apache Subversion][1] version control.
+
+## Browse the source code
+
+[Browse Airavata repository][2].
+
+## Check out the source code
+
+    svn co https://svn.apache.org/repos/asf/incubator/airavata/trunk airavata
+
+## Developers Guide
+
+Some coding practices:
+
+* License Header: Always add the current ASF license header as described in [ASF Source Header][3].
+* Trailing Whitespaces: Remove all trailing whitespaces. Eclipse users can use Source->Cleanup option to accomplish this.
+* Indentation: Use 4 space indents and never use tabs!
+* Line wrapping: Use 120-column line width for Java code and Javadoc.
+* Author Tags: Do not use Author Tags. The code is developed and owned by the community. 
+
+
+### Eclipse Configuration Tips
+
+  * Download [Eclipse IDE for Java EE Developers][4]
+  * Add [M2Eclipse][5] pluggin.
+  * Add [Subclipse][6] pluggin
+
+Configure Eclipse Prefernces
+
+  * Download Eclipse Formatting and Style Guides for [Airavata][7]
+  * To add Formatter: Preferences > Java > Code Style >  Formatter and import the airavata-formatting-preferences.xml downloaded in the previous step. 
+  * To add Templates: Preferences > Java > Code Style > Code Templates and import the airavata-code-style-template.xml. This templates adds the ASF header and so on for new code. 
+
+
+[1]: http://subversion.apache.org
+[2]: http://svn.apache.org/viewvc/incubator/airavata/
+[3]: http://www.apache.org/legal/src-headers.html
+[4]: http://www.eclipse.org/downloads/
+[5]: http://m2eclipse.sonatype.org/sites/m2e
+[6]: http://subclipse.tigris.org/update_1.6.x/
+[7]: http://svn.apache.org/repos/asf/incubator/airavata/etc/eclipse/