These are some excerpts from our coding standards document. They are general enough that no proprietary information is popping out but give a good feel for how we are trying to continuously improve our software engineering and code.
It intentionally reads more as a strategy document which outlines the strategies for how the code is to be implemented and written; rather than forcing developers to all adhere to one iron standard that is
absurd in its micromanagement.
Coding Principles
- Leave the code in a better state than when you found it.
- This means;
- Unit Tested
- Readable
- Properly formatted
- Properly commented
Refactoring
- Only refactor once there is unit test coverage
- Only refactor once there is functional test coverage
Commenting
- Javadoc where it makes sense. Especially on the interfaces to beans.
- Don't put the bug number in an inline comment. Subversion and JIRA track this.
- Don't put the developer name on a function. Subversion and JIRA track this.
- Don't comment out code. Delete it instead. Subversion will record the code that was removed.
Functions and Methods
- Keep functions as small as possible
- Name functions in a descriptive manner
- Keep variables in as local a scope as possible
- Name variables in a descriptive manner.
- Group related functions together in the class.
- Try to limit nesting in functions to two levels.
Unit Testing
- Keep unit tests clean and readable
- One concept per test
- Test names in the BDD form of shouldNotPassForReasonX()
Functional Testing
Keep the functional tests clean and readable- One concept per test
- Test names in the BDD form of shouldPassForReasonX()
- Functional tests should be black box and hit either webservices or remote interfaces.
Continuous Integration
- Projects must be set up in Bamboo
- Projects must run unit test checks every time code is checked in
- Projects must have ant build scripts for build, test and deployment
- Projects must deploy to the different environments through Bamboo
The document does include some coding and formatting standards, such as if statements always having brackets, but these
are enforced usually for quality reasons than for ones of taste and style.
Most Popular on South Sea Republic
The articles that have been viewed the most:
Most Popular Restaurants in Phoenix
Phoenix Eats Out is the restaurant review site for
Phoenix,
Scottsdale and
Old Town Scottsdale which lists the modernist and contemporary restaurants, taverns and bars in the greater Phoenix area.
This is the list of the most popular restaurants pages from phoenixeatsout.com that have been viewed the most;
My personal favourite restaurants in Phoenix are
AZ88,
Postinos,
Bomberos with
Grazie,
Humble Pie,
Orange Table,
The Vig,
Fez and others coming close behind. View the complete list with the photo-journalistic style images on
phoenixeatsout.com
Most Popular Hikes in Arizona
Arizona is an outdoor state and has lots of hiking in the city and around the state. Phoenix is unusual for most cities in having several large mountains in the center of the city with great hiking. Anyone who comes to Phoenix has to do the
Echo Canyon trail on Camelback and the
Summit Hike on Squaw Peak or Piesta Peak. The views of the city, suburbs and surrounding mountains are wonderful from Camelback and Piesta Peak.
For more experienced hikers there is the McDowell Mountains in North Scottsdale that has several difficult and strenuous hikes in
Tom's Thumb and
Bell Pass. Alternatively, you can hike the highest mountain in Arizona. At 12,600 feet
Humphrey's Peak is a long and difficult hike.
Alternate Australian Constitutions
Between 2004 and 2009 this site,
southsearepublic.org, was a constitutional blog based on scoop which focused on Australian and global constitutional issues.
One of the strongest aspects of it was the development of constitutions by those involved in the blog. These constitutions are the outcome:
The constitutions were built using principles from Montesquieu's separation of powers, the enlightnment's universal political rights and the ancient Athenian technology of sortition and choice by lot.
Archives For South Sea Republic
South Sea Republic started in 2004 as an Australian constitutional blog in 2004 based on scoop software. It was an immigrative outgrowth of Kuro5hin. The archives for each year since then;
The articles are ordered by views.
Who Is Cam Riley
I am an Australian living in the United States as a permanent resident.
I am a software developer by trade and mostly work in Java and jump between middleware and front end.
I originally worked in the New York area of the United States in telecommunications before moving to Washington DC and
working in a mix of telecommunications, energy and ITS. I started my own software company before heading out to
Arizona and working with Shutterfly. Since then I have joined a startup in the Phoenix area and am thoroughly enjoying myself.
I do a lot of photography which I post on this website, but also on flickr. I have a photo-journalistic website which lists
the modernist and contemporary restaurants in phoenix. I have a site on the
Australian Flying Corps [AFC] which has been around since the 1990s and which I unfortunately
lost the .org URL to during a life event; however, it is under the
www.australianflyingcorps.com URL now.
The AFC website has gone through several iterations since the 90s and the two most recent are
Australian Flying Corps Archives(2004-2002) and
Australian Flying Corps Archives(2002-1999) which are good places to start.
Websites Worth Reading
Websites of friends, colleagues and of interest;
