Contribution Guide

Before You Start:

• You should have some idea about the project and it's purpose. If you don't... start here: http://madlib.net
• You should be familiar with the project contents. If you are not... look at this:
  • Existing methods: http://devdoc.madlib.net
  • Development Status
  • Future methods: Contrib Status
• You should have some knowledge on relational databases, SQL, Python, C/C++, statistics and machine learning.

Step 1: Make friends with GitHub

• Create an account on GitHub.com.
• Get a git client from git-scm.com.
• Play with it. Follow Bootcamp guides on help.github.com to gain some confidence.

Step 2: Pick your project

• Create an account on MADlib JIRA and review the Open issues.
• Found one that you like?
  • Write a Comment and ask for assignment.
• Can't find anything to work on or have a question?
  • Send a message to Dev Forum

Step 3: Fork MADlib project

• Go to GitHub and fork MADlib project.
  • 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...

Uusing your own copy/fork of the MADlib repository. And remember about:

• Good coding practices: Coding Patterns & Best Practices Guide
• Proper API: SQL API Guide
• Full documentation: Documentation Guide (Doxygen)
• Installer Compliance: MADlib Installer Guide
• Comprehensive Unit Tests: Unit Testing Guide

Step 5: Send pull-request

• Done with coding?
  • Make a pull-request from your forked repository. Help on pull-requests
• This will generate an email to project commiters.
• Someone will review your changes and merge them into madlib/madlib.