Open jodygarnett opened 5 years ago
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!
Notes on code formatting:
indent:
Line wrapping
Organize imports
Code templates
/**
* @author ${user}
*
* ${tags}
*/
Why is this still open?
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:
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:
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