Changes between Version 2 and Version 3 of DevelopmentGuidelines


Ignore:
Timestamp:
Feb 7, 2011, 4:49:46 PM (8 years ago)
Author:
jannekevdp@…
Comment:

--

Legend:

Unmodified
Added
Removed
Modified

  • DevelopmentGuidelines

    v2 v3  
    11= GSCF Development Guidelines =
    22== JavaScript ==
    3 * JavaScript is stored in /js/
    4 * to reduce browser overhead we ''only'' use the jQuery JavaScript framework (so ''no'' mootools, yui, prototype, etc). jQuery is widely used by Google, Amazon, Microsoft, IBM, Twitter, etc... More information can be found [http://grails.org/jQuery+Plugin here].
    5 * for fancy user interface widgets such as accordion or tabs, we use jQuery ui (http://jqueryui.com/). Currently the CSS and JS of jQuery UI 1.7.2 (theme Pepper Grinder) are put into the /js/ and /css/jquery-ui/ folders. To use for example the accordion widget for a div with id 'idAcc' in you GSP, specify in head:
     3 * JavaScript is stored in /js/
     4 * to reduce browser overhead we ''only'' use the jQuery JavaScript framework (so ''no'' mootools, yui, prototype, etc). jQuery is widely used by Google, Amazon, Microsoft, IBM, Twitter, etc... More information can be found [http://grails.org/jQuery+Plugin here].
     5 * for fancy user interface widgets such as accordion or tabs, we use jQuery ui (http://jqueryui.com/). Currently the CSS and JS of jQuery UI 1.7.2 (theme Pepper Grinder) are put into the /js/ and /css/jquery-ui/ folders. To use for example the accordion widget for a div with id 'idAcc' in you GSP, specify in head:
    66{{{
    77      <g:javascript library="jquery"/>
    … …  
    2020
    2121== Images ==
    22 * images are stored in /images/* and images should be grouped in logically named directories (for example: /images/icons/famfamfam/*)
    23 * whenever images are used, optimize them for the web (in Photoshop: file --> Save for Web & Devices --> jpeg 80%)
     22 * images are stored in /images/* and images should be grouped in logically named directories (for example: /images/icons/famfamfam/*)
     23 * whenever images are used, optimize them for the web (in Photoshop: file --> Save for Web & Devices --> jpeg 80%)
    2424
    2525== IDE ==
    26 * we develop using the [http://www.netbeans.org/downloads/index.html NetBeans IDE] tightly integrates with Groovy & Grails (install the Groovy & Grails plugin)
    27 [[Image:Screen shot 2009-11-02 at 3.35.26 PM.png]]
     26 * we develop using the [http://www.netbeans.org/downloads/index.html NetBeans IDE] tightly integrates with Groovy & Grails (install the Groovy & Grails plugin)
     27[[Image(screenshot.png)]]
    2828
    2929== Tabs & Indentation ==
    30 * use the following settings for tabbing and indentation
     30 * use the following settings for tabbing and indentation
    3131[[Image:Screen shot 2009-11-02 at 3.10.53 PM.png]]
    3232
    3333== Subversion commits ==
    34 * Commit logical changesets
    35 * When you commit a change to the repository, make sure your change reflects a single purpose: the fixing of a specific bug, the addition of a new feature, or some particular task. Your commit will create a new revision number which can forever be used as a "name" for the change.
    36 * if you break the repository you have to get cake!
     34  * Commit logical changesets
     35 * When you commit a change to the repository, make sure your change reflects a single purpose: the fixing of a specific bug, the addition of a new feature, or some particular task. Your commit will create a new revision number which can forever be used as a "name" for the change.
     36 * if you break the repository you have to get cake!
    3737
    3838== Naming conventions ==
    39 * In Java, naming conventions for identifiers have been established and suggested by various Java communities such as Sun Microsystem<ref>"Code Conventions for the Java Programming Language", [http://java.sun.com/docs/codeconv/html/CodeConventions.doc8.html Section 9: "Naming Conventions"]</ref>, Netscape<ref>"NETSCAPE'S SOFTWARE CODING STANDARDS GUIDE FOR JAVA",[http://collaboratory.emsl.pnl.gov/docs/collab/sam/CodeStandards.html Collab Software Coding Standards Guide for Java]</ref>, AmbySoft<ref>"AmbySoft Inc. Coding Standards for Java v17.01d", [http://www.ambysoft.com/essays/javaCodingStandards.html]</ref> and etc. A sample of naming conventions set by Sun Microsystem are listed below:
     39 * In Java, naming conventions for identifiers have been established and suggested by various Java communities such as Sun Microsystem<ref>"Code Conventions for the Java Programming Language", [http://java.sun.com/docs/codeconv/html/CodeConventions.doc8.html Section 9: "Naming Conventions"]</ref>, Netscape<ref>"NETSCAPE'S SOFTWARE CODING STANDARDS GUIDE FOR JAVA",[http://collaboratory.emsl.pnl.gov/docs/collab/sam/CodeStandards.html Collab Software Coding Standards Guide for Java]</ref>, AmbySoft<ref>"AmbySoft Inc. Coding Standards for Java v17.01d", [http://www.ambysoft.com/essays/javaCodingStandards.html]</ref> and etc. A sample of naming conventions set by Sun Microsystem are listed below:
    4040{| class="wikitable" border="1"
    4141|-
    … …  
    6565
    6666Note: while class names start with an uppercase character, instances of classes are variables and hence start with a lowercase character.
    67 
    68 [[Category:GSCF]]