Welcome and thank you for your interest in contributing to Usergrid! This guide will take you through the process of making contributions to the Usergrid code base.
Contributor license agreement
How to contribute
0. Talk to us
If it's your first contribution or it's a particularly big/complex contribution, things typically go much more smoothly when they start off with a conversation. Visit our Community page to see how you can contact us and how to join the developers and users mailing lists.
1. Create an issue in JIRA
Your first step is to create or find an issue in JIRA for your feature request or fix. If it's a simple cleanup, this isn't necessary, but it's good to see if your change fixes an existing issue anyway. If it's a formatting issue alone, consider creating an issue for us to fix our checkstyle configuration to catch it in the future.
2. Create a pull request in GitHub
Next, you'll want to create a pull request (PR) in GitHub for the change you're interested in making. The comment section of the PR must contain a link to the JIRA issue (if it has one). Please also reference the issue in the commit message, and make sure it properly describes the changes that have been made and their purpose (here are some guidelines). If you need the commit backported to one of the release branches (e.g. 1.0.x), make a note about that in the comment too and set the Affects Version/s of the issue accordingly.
Some good references for working with GitHub are below. We ask that you keep your change rebased to master as much as possible, and we will ask you to rebase again if master has moved before accepting your patch.
3. Comment the issue in JIRA
Finally, add a comment in the JIRA issue with a link to the pull request so we know the code is ready to be reviewed.
The review process
The Usergrid community will review your pull request before it is merged. This process can take a while, so please be patient.
If we are slow to respond, feel free to join us in irc on irc.freenode.net #Usergrid and ask for help. Feel free to also email our dev dev mailing list: email@example.com. To subscribe send an email to firstname.lastname@example.org.
During the review process you may be asked to make some changes to your submission. While working through feedback, it can be beneficial to create new commits so the incremental change is obvious. This can also lead to a complex set of commits, and having an atomic change per commit is preferred in the end. Use your best judgement and work with your reviewer as to when you should revise a commit or create a new one.
A pull request is considered ready to be merged once it gets at lease one +1 from a reviewer. Once all the changes have been completed and the pull request is accepted, it must be rebased to the latest upstream version . It is also a good idea to squash all the commits into a single one, since this will allow us to generate a clean patch and merge it properly.