This page contains general guidelines and procedures for contributing code. If you have any questions we invite you to ask on the maria-developers mailing list or on the #maria IRC channel on Freenode. Other email lists and places to find MariaDB can be found here

General information about contributing to MariaDB (for developers and non-developers) is found on the Contributing to the MariaDB Project page.

Finding development projects to work on

There are many open development projects for MariaDB which you can contribute to (in addition to any ideas you may have yourself).

  • We are using JIRA to manage the MariaDB project. Go to http://mariadb.org/jira and click on "Projects" to get to the MariaDB project. Browse around the unresolved and unassigned issues to see if there is something that interests you. Some issues have sponsors and you can be paid for doing them!
  • Join maria-developers and write to the maria-developers \at\ lists.launchpad.net list and ask for suggestions of tasks you could do. Please include your programming experience and your knowledge of the MariaDB source and how much you know about using MySQL/MariaDB with the email so that we know which tasks we can suggest to you.
  • If this is your first project, check out the Suggested Development page. It lists projects that will make a good start.
  • Join irc:irc.freenode.net/maria on Freenode IRC and ask for suggestions.

If you have your own ideas, please submit them to JIRA so other MariaDB developers can comment on them and suggest how to implement them. You can of course also use the maria-developers list for this.

Prerequisites

You need Bazaar for revision control.

bzr Login Setup

  • Get a launchpad account at https://launchpad.net/+login
  • When logged in, setup your SSH keys
    • Click your name (top right corner)
    • Click Change Details link (upper right)
    • Click SSH Keys button (middle of page)
    • Upload your public SSH key (How do I get a public key?)
  • Register yourself with launchpad from your local commandline: bzr launchpad-login [yourloginid]

Getting the Maria Code

  1. First, get a clean copy of the MariaDB code (for some, the fastest way to get up and running is to follow the instructions in the "Source Tree Tarball" section).
  1. Once you have a clean copy of the source, create a working copy for your changes:
cd $maria-repo # ex: ~/repos/maria
bzr branch trunk maria-fix-bugNNNNNN
cd maria-fix-bugNNNNNN

Tip: Use descriptive names such as maria-fix-bugNNNNNN (where NNNNNN is the bug # of course).

  1. You should now be ready to Compile MariaDB. It's a good idea to compile at this stage to confirm the source tree you are going to be hacking on works . . . before you make any changes.

The following pages will help you get up and running with the MariaDB source code:

Setting up tests

The Maria test suite is contained in the ./mysql-test/ subdirectory of the source tree. The mysql-test directory has two subdirectories of utmost concern to you, the bug fixer: the t/ directory and the r/ directory (for "tests" and "results" respectively). Be sure to check and see if your bug already has a test too.

All the tests are found in the t/ directory. Open up the file that corresponds to the functionality you are changing (or add a new file) and add the commands that will reproduce the bug or validate the new functionality.

For example, the test below creates a new test table "t1"; shows us the result of that CREATE TABLE statement; and lastly, we cleanup the test by dropping the test table:

#
# Bug #XXXXXX: INET_ATON() returns signed, not unsigned
#
create table t1 select INET_ATON('255.255.0.1') as `a`;
show create table t1;
drop table t1;

By adding your test first, it will remind you to re-record the test output file later (and inform future efforts about your expected output, of course). Now it's time to make your changes.

Examine existing tests to get a better idea of how you should write your test.

We are always on the lookout for better tests, so if you create new test or improve an existing test, please upload it to the "private" folder on our FTP server and then ping us on IRC or send a note to the Maria-Developers mailing list to let us know about it.

Editing and adding to your contribution

With a working version, you can commence making changes in your new branch, committing code regularly to your local working copy; feel free to commit early and often as you will formalize your contribution later with a push and proposal.

cd $maria-repo/maria-fix-bugNNNNNN
# Make Changes
bzr commit -m "Merge comment"

Prior to publishing your completed work, you need to confirm that your branch works as expected and update the test runs.

To allow others to see your commits, you should configure bzr to send its commit emails to commits 'at' mariadb 'dot' org email list.

Testing your branch

Make sure you have at least libtool 1.5.22 (found here).

First, check to see that all the tests pass (remember the test you set up earlier? It should fail. That's ok, you will re-record it momentarily):

cd $maria-repo/mysql-test
./mysql-test-run

Any that fail will need to be re-recorded.

cd $maria-repo/mysql-test
./mysql-test-run --record $test # where $test is the name of the test that failed 

You are now ready to merge into trunk.

Merging recent changes

It is important to merge any changes from trunk into your branch before pushing or publishing.

Update your local trunk.

cd $maria-repo 
cd trunk
bzr pull

Updating your local branch.

cd $maria-repo
cd maria-fix-bugNNNNNN
bzr merge ../trunk
bzr commit -m "Merged from trunk"

Conflicts can be resolved in bazaar via:

bzr resolve $filename

To revert to your last commit on your branch use:

bzr revert $filename

(Note you will need to remerge with trunk before pushing)

Verify differences carefully

bzr diff

Publish your branch

When all changes are merged and your changes are all consistent you can push your branch to LaunchPad

cd $maria-repos/$your-branch # where $your-branch is the branch you want to push (ex: maria-bugNNNN)
bzr push lp:~[yourloginid]/maria/$your-branch

If you find that this takes a very long time (eg. >30 minutes), you may want to try using 'bzr init-repo --format=1.9' to initialize a new repo and merge your work into it, then push again.

How to propose branch for merging

On your Launchpad Code page https://code.launchpad.net/~{yourloginid}/maria/{branch-name} click the Propose for merging into another branch link to propose branch to the maintainers to be merged into the main trunk.

Getting your code into the main MariaDB tree.

All code in MariaDB comes from one of the following sources:

  • MySQL
  • Code developed by people employed by the MariaDB Foundation.
  • Code developed by people employed by SkySQL.
  • Code shared with the MariaDB Foundation under the MCA.
  • Code with a known origin that is under a permissive license (BSD or public domain).

If you want the code to be part of the main MariaDB tree, you also have to give the MariaDB Foundation a shared copyright to your code. This is needed so that the foundation can offer the code to other projects (like MySQL).

You do this by either:

  1. Signing the MariaDB Contributor Agreement (MCA) and then scanning and sending it to the foundation.
  2. Sending an email to maria-developers where you say that your patch and all fixes to it are provided to the MariaDB Foundation under the MCA.
  3. Licensing your code using the BSD license.

We need shared copyright for the following reasons:

  1. to defend the copyright or GPL if someone breaks it (this is the same reason why the Free Software Foundation also requires copyright assignment for its code)
  2. to be able to donate code to MySQL (for example to fix security bugs or new features)
  3. to allow people who have a non-free license to the MySQL code to also use MariaDB (the MCA/BSD allows us to give those companies the rights to all changes between MySQL and MariaDB so they can use MariaDB instead of MySQL)

More information about the MCA can be found on the MCA FAQ page.

Fix Branch (if needed)

If fixes are needed on your branch you will need to: make the changes, re-merge any new changes to trunk, commit and re-push; you do not need to re-propose. After the push, LaunchPad will pick up the changes automagically.

Please be aware that changes can take a few minutes for LaunchPad to merge your new changes into your proposal.

How to re-submit a Proposal

At the moment, this is a tricky process, and none of the "Request another review" links on Launchpad work.

To resubmit a merge proposal, follow these steps:

  1. On the main page of the merge proposal, the top line will be something like "Status: Needs Review". Just to the right of this is a small button; click on this to change the status.
  2. Select "Resubmit" from the drop down menu and click "Change Status".
  3. The next page should prompt you to resubmit the merge proposal and inform you that the new proposal will supersede the old one
  4. Click "Resubmit" to finish.

A couple of easy ways to get attention to your proposed merge are:

  • Join the #maria IRC channel on freenode ask people to review/discuss your merge.
  • Subscribe to and send an email to the maria-developers group on Launchpad.

Comments

Comments loading...