[SHINDIG-1531] Updating and defining coding convention best practices

• Type: Improvement
• Status: Open
• Priority: Major
• Resolution: Unresolved
• Fix Version/s: 2.5.3
• Component/s: Java, Javascript , Website
• Assignee: Unassigned
• Reporter: Stanton Sievers
• Created: 28/Apr/11 15:13
• Updated: 26/Nov/14 18:28

Description

The shindig wiki provides information regarding Shindig code style and coding conventions on these pages: http://shindig.apache.org/community/conventions/code.html and https://cwiki.apache.org/SHINDIGxSITE/java-style.html

This information is incomplete, outdated, or incorrect in some places.

Incorrect:

• The links on this page (http://shindig.apache.org/community/conventions/code.html) to Eclipse configuration files in the SVN repository are broken.
• The links to the "How to Contribute" page in the PHP and JavaScript sections are broken

Incomplete:

• http://shindig.apache.org/community/conventions/code.html provides no JavaScript conventions

Outdated:

• The Eclipse configuration files do not match the newer coding conventions outlined on this page: https://cwiki.apache.org/SHINDIGxSITE/java-style.html

The original configuraiton files were created as part of this JIRA https://issues.apache.org/jira/browse/SHINDIG-76

You can see the changes I've made to the configuration files and the proposed new configuration files here: http://codereview.appspot.com/4453050/