Fork me on GitHub

Contribute

There are many ways you can help the Groovy development team improve the Groovy programming language. And all help is welcome to make a difference, by:


Discussing on the mailing-lists

If you encounter a problem, want to discuss a new feature, share interesting findings, and more, then the mailing-lists are the place to go to to start a conversation with the Groovy developers and other Groovy users.


Reporting issues

The Groovy project is using the JIRA bug tracker to report and track issues, feature enhancements, and new features. Be sure to be signed-up and logged-in, before proceeding.


Improving the documentation

The documentation of the Groovy programming language comes in various forms:

To contribute to the Groovy reference documentation, this blog post gives all the details on how you can work on that documentation.

All the above is stored in our code repositories on Github, so having an account on Github would be ideal.

Contributing to this website is fairly easy, if you have a Github account already, as you can click on the Improve this doc buttons that you can see on all the pages of this website. So don't hesitate to help us improve it, fix typos, broken language, clarify complicated sections, add new material, etc.

Please check the following section for more information on how to contribute to our codebase.


Contributing code

If you know the area you want to contribute to, this is great, but if you are looking for some first contributions, the Groovy development team tries to maintain a list tickets of possible easy contributions that you could get you started on your journey to become of Groovy committer. Just raise your hand on the Groovy developer mailing-list to tell us about your desire to work on that ticket.

For more complicated tasks, the best approach is also to bring that to the attention of the Groovy developers, so they can give you some guidance on how best to tackle a particular problem, discuss implementation ideas and the semantics or scope of the proposed change.

Cloning the code base

To work on the Groovy code base, you should be proficient enough in git and you should have an account on Github to be able to create pull requests with your changes.

Please fork https://github.com/apache/incubator-groovy and create a local clone of your fork as explained in fork a repo.

Make sure you configure Git appropriately with the same email that you registered with on Github:

git config --global user.name "YOUR NAME"
git config --global user.email "YOUR EMAIL"

You can verify these are configured appropriately by running:

git config --list

Working on the code base

If you are working with the IntelliJ IDEA development environment, this screencast gives lots of details on how to setup your IDE.

Then, to work on the Groovy code base, to build and test Groovy, you can follow the instructions from the readme file in the Groovy repository.

The most important command you will have to run before sending your changes is the test command:

./gradlew test

For a successful contribution, all tests should be green!

Creating a pull request

Once you are satisfied with your changes:

  • commit your changes in your local branch
  • push your changes to your remote branch on Github
  • send us a pull requests

Build status

The Groovy sources are tested thanks our continuous integration server.