Contribution Guide

Before You Start:

• You should have some idea about the project and its purpose. If you don't, start here: http://madlib.net
• You should be familiar with the project contents. If you are not, look at below links:
  • Existing methods: http://devdoc.madlib.net
  • Development Status
  • Future methods: Contrib Status
• You should have some knowledge on relational databases, SQL, Python, C/C++, and analytical methods that you want to implement.

Step 1: Make friends with GitHub

• Create an account on GitHub.com.
• Get a git client from git-scm.com.
• If you are not familiar with this version control software follow Bootcamp guides on help.github.com to gain some confidence.

Step 2: Pick your task

• Create an account on MADlib JIRA and review the Open issues.
• Found one that you like?
  • Write a Comment and ask for assignment.
• Know what you want to work and we don't have it on JIRA.
  • Open a JIRA ticket (bug, task, or new feature) and let us know (in a Comment) you are working on it.
• Don't know what to work on or have any other question?
  • Post a message to MADlib Dev Forum

Step 3: Fork MADlib project

• Go to GitHub MADlib repo and fork the project using the FORK button (top right).
  • This step will create a "connected" copy of madlib/madlib repo under yourGitHubAccount/madlib.
  • Need some help with forking? Check here

Step 4: Develop away...

by using your own copy/fork of the MADlib repository.

Make sure you have all the module components in place: MADlib Module Anatomy

And remember about:

• Good coding practices: Coding Patterns & Best Practices Guide (COMING SOON)
• Proper SQL API: SQL API Guide
• Complete documentation: Documentation Guide (NEEDS REVIEW)
• Comprehensive unit tests: Unit Testing Guide (NEEDS REVIEW)

Step 5: Send pull-request

• Done with coding? Follow this:
  • Test build/install/execution on your side. If no problems...
  • Create a pull-request from your forked repository. Get some help on pull-requests here.
  • Create a JIRA Task (subject: "pull request") and explain the details: http://jira.madlib.net/
  • Put the github pull request link into the JIRA. If you know who would be the best reviewer assigne the JIRA to that person. Otherwise don't worry.
  • Code comments are easy to add on Github. JIRA better serves as a high level log tracker.
  • Once the code is merged - Github pull request closes automagically, JIRA must be closed manually.