FOSS4G2017 logo

Previous topic

Contributing to GeoMOOSE

Next topic

GeoMOOSE Release Procedure

This Page

GeoMOOSE Coding StandardsΒΆ

  1. Code Formatting.
  1. Tabs, not spaces. This formatting rule is a a matter of religion. GeoMOOSE worships in the House of “\t”. Code submissions will be returned if the indentation uses spaces.
  2. function brackets should be at the end of a function declaration.

Bad:

foo: function ()
{
}

function foo ()
{
}

Good:

foo: function () {
}

function foo() {
}
  1. Methods should be camelCased.

  2. Private methods should begin with an underscore.

    _myPrivateMethod: function () {
    }
    
  3. Variable names inside of methods and functions should use under case and be underscore delimited.

    var my_variable_in_a_function = 0;
    
  4. Please format comments to be parsed with NaturalDocs. This is the same library used by OpenLayers. This allows for better class and API documentation building.

  1. Do not create new dependencies in the core. Adding a library dependency is not something the GeoMOOSE team takes lightly. By comparison to other Web GIS distributions we strive to keep GeoMOOSE very light. We work quite hard to keep it appropriate for distribution to the public and to devices with limited bandwidth.
  2. DRY - Don’t Repeat Yourself.
  1. Scour the documentation first, especially the GeoMOOSE API namespace, there is a lot of functionality there.
  2. Check OpenLayers, especially OpenLayers.Util.
  3. Subclass! Copying and pasting is ugly and creates long term support-ability issues. You are very likely copying and pasting the bugs into your code.
  1. Keep UI and Library code separate. It may be tempting, with Javascript, but please keep oil out of the water - fragile sea-life depends on you. In a more serious note, if a function is meant to put content somewhere, write a function that generates the content in a machine parse-able format and separate code that renders it.
  2. All diff/patch files should indicate a version. Patches can be sent to the GeoMOOSE mailing list. The email should include a major GeoMOOSE version or an SVN revision number.
  3. All code submitted to GeoMOOSE should be free and clear of all license restrictions. If any one can claim ownership, a license, patent, or copyright we will reject the code. If you are not on the committers list then please include a message releasing the code into the public domain. Please reference the GeoMOOSE license for the terms under which GeoMOOSE is distributed.
  4. Any contributed code should contain a code source comment block in each file header indicating the author (that is you and your employer if you are working on company time), date of contribution and any conflicting licensing restrictions that are not already covered by the GeoMoose GeoMOOSE License. All unusual situations need to be discussed and/or documented on the project mail list and/or in the project TRAC system.

Here are some example comment blocks for code contributors:

If you donated a file to the GeoMoose project, using an MIT license, the comment block would include:

Copyright (c) 2013, <YourName> (<YourCompanyName>)

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

The accepted project code would be distributed as:

Copyright (c) 2013 Dan “Ducky” Little & Geomoose.org

Copyright (c) 2013, <YourName> (<YourCompanyName>)

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sub-license, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.