Last updated by 3 years ago

Page: Contribute, Version:20

How to Contribute

We're always on the lookout for people who can contribute to Grails. There are four main areas of activity: raising issues, improving the documentation, contributing to the Grails codebase, and developing plugins.

Raising issues

All Grails issues are stored in a JIRA instance at Codehaus. You have to create an account before you can start raising issues, but once that's done you're good to go.

Here are a few tips for creating issues:

  • Do a quick search beforehand to check whether someone else has already raised the issue. You can use the quick search box in the top righthand corner, but if you do, start your query with "grails" so that it only searches the Grails project.
  • Try to include as much pertinent information as you can in the summary. "Pages are displayed wrong" is not helpful. "Stylesheet in GSP layout is not being applied" is much better.
  • If you can't categorise your issue with one of the available components, don't worry - just leave it empty.
  • Provide a reproducible example (typically a zipped Grails project) with instructions on how to reproduce the problem.
  • Even better, provide some test cases in the project if you can. Integration or functional tests are usually the most appropriate. This will make it much easier for us to diagnose and fix the issue.
Although issues are much more likely to be tackled if they have reproducible examples attached, it's better to raise one without a reproducible example than not raise one at all.

Coding

If you want to get involved in the development of Grails then these documents should help you get started:

Plugins

If you want to contribute to existing plugins or distribute your own, then follow the steps described at the end of Creating Plugins.

Documentation

This site (grails.org) documents Grails and is a wiki. You are encouraged to contribute to the documentation by adding and editing.

Here's a description of the wiki syntax that we use.