[edit] WARNING: This is the _old_ Lustre wiki, and it is in the process of being retired. The information found here is all likely to be out of date. Please search the new wiki for more up to date information.

Contribution Policy

From Obsolete Lustre Wiki
(Difference between revisions)
Jump to: navigation, search
(Submitting Patches for Review)
(change email address from bugs@clusterfs.com)
Line 46: Line 46:
 
* Provide the patch as an Attachment, and select the Patch box.
 
* Provide the patch as an Attachment, and select the Patch box.
 
* Edit the new attachment. Under "Flags" select "Review" and the question mark.
 
* Edit the new attachment. Under "Flags" select "Review" and the question mark.
* Enter the email address of the person who should review.  If you haven't been collaborating with someone, and don't know who should review your work, try [mailto:bugs@clusterfs.com bugs@clusterfs.com]
+
* Enter the email address of the person who should review.  If you haven't been collaborating with someone, and don't know who should review your work, try [mailto:lustre-rmg-team@sun.com lustre-rmg-team@sun.com]
 
* Submit the attachment update.
 
* Submit the attachment update.
  

Revision as of 16:47, 15 May 2008

Contents

Getting Started

We are very excited to receive outside contributions -- many of our employees first became involved with Lustre® by making patches and demonstrating their expertise as outsiders.

Learning enough about Lustre to make serious changes is a fairly daunting task: Lustre solves a lot of very challenging problems, and doing so inevitably requires complexity. Unfortunately, as is the case with too much software, there is not a lot of detailed documentation about the internals of Lustre. In many places the APIs are decent and the functions self-explanatory; in many places they are not.

The Developer Resources section includes basic information about how to check out code, patch your kernel, build a tree, and run simple tests. If you run into difficulties you may be able to get help from the lustre-discuss mailing list.

One Legal Hurdle

Before you can contribute code to Lustre, or get write access to the CVS repository, you need to sign and return our Contributor Agreement. We require this step for several reasons:

  • We need to make sure that you're only contributing code that you own. By certifying that you wrote the code (and that you control the rights), you take legal responsibility for your contribution.
  • By agreeing to Joint Copyright, you make it easier for us to protect the project and company from license violations -- only the copyright holder is empowered to act against violations (see the FSF's comments about this topic).
  • You also make it possible to continue to sell and distribute Lustre under other licenses, including non-free licenses. This business model is what pays the bills, allowing us to maintain and improve Lustre, release the code under an open source license, and participate in open development (which, generally speaking, pays few of the bills).

Because you remain a copyright holder of what you wrote, you can use the code you contributed in almost any fashion. Of course, this only applies to the software that you contribute, not software written by others.

We will gladly acknowledge your authorship in the source code -- our point is not to try to take credit for your work. If you make a substantial contribution, please update the boilerplate at the top of the source file as part of your patch.

Finally, if you write software for a living (or attend a university), there is a good chance that your organization owns all of the software that you create. In this case, you have three options:

  • Get an officer or authorized representative of the organization to contribute the software.
  • Get an officer or authorized representative of the organization to waive its rights to your software, so that you can contribute it yourself. In this case, please enclose a short waiver signed by the officer.
  • Do not contribute the software.

You are responsible for making sure that you control the rights to the software before you contribute it -- if there is any doubt, please consult the organization or an attorney. If you ever find that you contributed software that you shouldn't have, for any reason, please notify us right away.

Making a Contribution

When you're ready to have your patch reviewed and committed, please do so via Bugzilla. Learn the following process.

Submitting Patches for Review

To have your changes accepted into a mainline Lustre branch, you must have your code reviewed and approved. The following steps will speed up your review and increase the likelihood of success:

1. Read, complete, and return the form found at Contributor Agreement We can't accept your contributions without it.

2. Generate a patch with the "-upN" flags to diff or cvs diff. Please don't send other kinds of patches unless your reviewer requests them.

3. Find or file a bug for your issue at http://bugzilla.lustre.org/ . Read the Bugzilla user guide for more information.

4. Attach your patch as an Attachment (not a comment):

  • Provide the patch as an Attachment, and select the Patch box.
  • Edit the new attachment. Under "Flags" select "Review" and the question mark.
  • Enter the email address of the person who should review. If you haven't been collaborating with someone, and don't know who should review your work, try lustre-rmg-team@sun.com
  • Submit the attachment update.

5. One or more reviewers will submit comments regarding your patch. Iterate until you receive approval on the patch or the bug is closed.

6. Once you have approval, commit the patch (or ask for it to be committed for you, if you don't have CVS access). Note the bug number and reviewer in the commit message, along with a concise description of the change.

This applies even if you have write access to the CVS tree -- if you don't follow these steps, expect your changes to be backed out of the tree without warning. We have to be strict, or the chaos becomes unbearable.

Branches

Our current policy is that anyone may create and maintain a private branch in CVS. We ask, however, that you observe the best practices outlined in this document. It will save you a lot of effort, I promise.

If you've demonstrated a history of good work by submitting several non-trivial and correct patches, you may want to have write access to the CVS tree (or a job at CFS). Let us know!

Personal tools
Navigation