wiki:Submitting

GRASS GIS development

GRASS - Geographic Resources Analysis Support System has been under continual development since 1982. The strength and success of GRASS GIS relies on the user community. With this in mind, the philosophy of the GRASS Development Team is to encourage users to develop their own unique tools and applications for GRASS. If you develop tools and techniques that you feel would benefit other GRASS users, please see below how to structure code and documentation for the benefit of all.

Submitting rules

Be sure to check your code against these rules:

GRASS GIS programming best practice

There are many unwritten rules how GRASS modules should work, what they should do and what they shouldn't do. There is always some reason why some things are considered as "good" or "bad", still they are just noted in some long GRASS developer mailing list conversations. These pages here aim at collecting such ideas which are floating around in the GRASS-dev mailing list (and other places) to help new module developers/bugfixers to understand many little tricks how GRASS modules should work.

New list item adding guide

List items should be short and general. Add only things that are relevant to all modules or module groups. There should be reason why such rule/hint exists - add reference to ML archive thread or short description why such rule is important. Look into SUBMITING documentation above for already existing specific rules. Feel free to add code/pseudocode samples, if they apply.

GRASS best practice list (unsorted)

GRASS GIS Addons

  • Check your code against the Submitting rules (see above)
  • Run source:grass-addons/tools/module_svn_propset.sh on your newly added files before submitting them. Among the others it's required to get "$Date$" text in your html and man help pages automatically update the Date keyword.
  • Upload your code with the svn client (SVN usage)
  • Once uploaded to the GRASS GIS Addons SVN repository:
    • Addons appear in the Addons manual pages when being registered in the parent Makefile
    • note to devs only: the addons are created via cronjobs (user can install them via g.extension)

Submitting code to SVN

Once SVN access is granted, the requester's "osgeo_id" will be enabled.

If you are not familiar with SVN, see our guide at SVN usage.

Note: If you want to suggest source code changes (most welcome!), please submit them as "diff" file and not as a full file: See HowToSVN Creating local diffs

See also

Last modified 18 months ago Last modified on Jun 3, 2016 2:49:10 PM