Update CONTRIBUTING.md with direct instructions for contributors

[jodygarnett]

The CONTRIBUTING.md file quickly links to wiki How-to-contribute page. The wiki page digs into the mechanics of how to contribute but does not really touch on the "agreement" to contribute code to the project.

This is important as the CONTRIBUTING.md link is shown to developers as they make a pull request. It is not much but it is something :)

Describe the solution you'd like

I would ask to see the CONTRIBUTING.md file focus what the contributor needs to do to pass a PR review:

• [ ] That files should have a GPL header, show an example :)
• [ ] code formatting?
• [ ] test case?
• [ ] documentation?

The header establishes that the author retains copyright and is agreeing to distribute the code as GPL v 2.0 or later. This is a powerful statement and allows GeoNetwork to accept the code into the project and then distribute in future builds.

Describe alternatives you've considered

Since GPL license is used there is no real business need to use OSGeo Contributor License Agreement. Only advantage of doing so would be the ability to share some code back to upstream projects like GeoTools (this can still be done but requires hunting down the contributor and asking).

Also consider using several examples:

• individual making the work
• an organization making the work (example used by an employee).
• a customer having work made (example used by a consulting company)

This is probably two complicated, key thing is a name and GPL agreement. If the contributor uses the wrong name then that is on their head.

Additional context

• https://github.com/geonetwork/core-geonetwork/blob/master/CONTRIBUTING.md
• https://github.com/geonetwork/core-geonetwork/wiki/How-to-contribute

/*
 * Copyright (C) 2001-2016 Food and Agriculture Organization of the
 * United Nations (FAO-UN), United Nations World Food Programme (WFP)
 * and United Nations Environment Programme (UNEP)
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or (at
 * your option) any later version.
 *
 * This program is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
 * General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
 *
 * Contact: Jeroen Ticheler - FAO - Viale delle Terme di Caracalla 2,
 * Rome - Italy. email: geonetwork@osgeo.org
 */

[jodygarnett]

Update: I found the code formatting in software_development readme, reduced to:

• Select Java > Code Style > Formatter
• Click Import and import code_quality/formatter.xml

The references formatter.xml which only works if you are using Eclipse IDE!

[jodygarnett]

Notes on code formatting:

• Java Code Style
• braces on the same line
• parens on the same line

indent:

• spaces only
• 4 character indent
• indent everything, except switch / case statements

Line wrapping

• 140 character line wrapping
• 2 character indent for wrapped lines, array initializers

Organize imports

• java
• javax
• org
• com

Code templates

• look really messed up, does not include project header
• comments look wrong

/**
    * @author ${user}
    *
    * ${tags}
    */

[jodygarnett]

Why is this still open?