Contribute

About

Open-CGF is a Java application designed according to this wiki page.

What you can do

Any help is appreciated, from coding to documentation. Anything you can do is appreciated. If you don't have time to code, you can help us by writing a review or telling a friend. It's that easy.

Areas we need you

Code

Code is the life-blood of this project! Any coding you can do will really help us out. Check the issues page for ideas on where to start. Make sure you document as you go (or at least leave an issue to let us know what needs documenting).

To help us maintain Open-CGF we use extensive unit-testing. JUnit5 is used for unit testing and all methods should have coverage before committing. If you can't/don't want to write unit tests, please leave an issue to let us know that a test needs to be written.

Documentation

To help Open-CGF out with documentation, you can either update stuff on GitHub (commenting code, adding to the wiki, filling in our user guide...) or you can help add to the our diagrams. We use Sketchboard.io , you can find all of our diagrams here. Just add a markdown note underneath to seperate each area, and commit it back to GitHub.

Releases

We periodically release versions in line with our Roadmap, any additional support you can give around these releases is much appreciated. Things like blogging about it, or simply using it and raising bugs for us to fix, really help us out.

Don't forget to add your name to our contributors list as well!