-
Notifications
You must be signed in to change notification settings - Fork 314
Contributing to Livy
Thanks for your interest in Livy!
Livy is an Apache-licensed open-source Apache Spark Job server. This document contains some guidelines for contributing to Livy.
First of all, you need to sign and return an "Individual Contributor Licensing Agreement" form (or a CCLA, if you’re contributing as part of your job), which is required before we can accept and redistribute your contribution. Once this is submitted - and you only need to do it once - you are free to start contributing to Livy.
Find a JIRA that you would like to work on (or file one if you have discovered a new issue!). If no-one is working on it, assign it to yourself only if you intend to work on it shortly.
Except for the very smallest items, it’s a very good idea to discuss your intended approach either on the JIRA or on the [email protected] mailing list. You are much more likely to have your patch reviewed and committed if you’ve already got buy-in from the livy community before you start.
Now start coding! As you are writing your patch, please keep the following things in mind:
First, please include tests with your patch. If your patch does not include tests, it will not be accepted. If you are unsure how to write tests for a particular component, please ask on the livy-dev mailing list for guidance.
Second, please keep your patch narrowly targeted to the problem described by the JIRA. It’s better for everyone if we maintain discipline about the scope of each patch. In general, if you find a bug while working on a specific feature, file a JIRA for the bug, check if you can assign it to yourself and fix it independently of the feature. This helps us to differentiate between bug fixes and features and allows us to build stable maintenance releases.
Finally, please write a good, clear commit message, with a short, descriptive title and a message that is exactly long enough to explain what the problem was, and how it was fixed.
We maintain a mailing list at [email protected], which is the right place for Livy development discussions. Questions about using Livy still belong on the Livy user list, which is [email protected].