Contributing

We really want you to get involved in the Scalate project, to join the community and help make it a better price of software - please do dive in and help!

Try surf the documentation and website in general - if somethings confusing or not clear, let us know or raise a support request.

Download the code and try it out and see what you think. Browse the source code. Got an itch to scratch, want to tune some operation or add some feature?

Want to do some hacking on the Scalate code? Try surfing the our Issue Tracker for open issues or features that need to be implemented, take ownership of an issue and try fix it.

Improving the documentation

Documentation is massively important to help users make the most of Scalate and its probably the area that needs the most help!

So if you are interested in helping the documentation effort; whether its just to fix a page here or there, correct a link or even write a tutorial or improve what documentation is already there please do dive in and help!

All of the documentation is stored in a GIT repo, see How the Site works

If you find a bug or problem

Please raise a new issue in our Issue Tracker. If you can create a JUnit test case then your issue is more likely to be resolved quicker. Then we can add your issue to our source control system and then we'll know when its really fixed and we can ensure that the problem stays fixed in future releases.

Working on the code and creating patches

We gladly accept patches if you can find ways to improve, tune or fix Scalate in some way.

New to GitHub?

We track patches by using GitHub. GitHub makes it easy to fork the project, and for the project team to monitor the progress of those forks and easily merge those forks back into the mainline. To get started with GitHub:

You will need a SSH key to push you changes to GitHub
Then create a GitHub account
Then configure git so that commits are linked to your GitHub account

Already a GitHub User?

go to the Scalate github page and follow the Forking Guide to get your own copy of the project.
hack your copy as much as you like, pushing your local changes back to your git repo on github.

Once your happy with your changes, notify us that that your want your changes merged back:

click on the pull request button the Scalate github page to let us know you've a patch you'd like to contribute.
you may want to create a new Issue in the Issue Tracker
fire off an email to the Community linking to the issue

When a ticket is created in JIRA it automatically sends an email to the commit mailing list but an email always helps alert folks (as lots of emails are generated from every change to every JIRA).

Becoming a committer

Once you have made some good contributions you may be invited to become a committer by the project team. We'll chat to you offline about it.