Contributions
From Open-FCoE Wiki
Contents |
[edit] Where to start?
There are a few places that an engineer should look when interested in contributing to Open-FCoE:
- The Open-FCoE TODO list
- The Open-FCoE Bugzilla
- The Open-FCoE mailing list
- The linux-scsi mailing list
[edit] linux-scsi
Open-FCoE was designed to be a Low Level Driver (LLD) of the Linux SCSI subsystem. Therefore all discussions related to the kernel code will take place on the linux-scsi mailing list. This spans everything from the code's architecture to bug fixes (in the form of patch files of course). If you want to know where Open-FCoE is in its effort to be included in a kernel this is where you'd look.
[edit] Bugzilla
To manage defects in the code changes we've created a Bugzilla on Open-FCoE.org to coordinate contributor's efforts.
[edit] Reporting
At the time of this page's writing there is no formal process for creating new defects. You may submit bugs as an anonymous user, but we would much prefer you register before submitting defects as then submitter and assignee can have discussions about the problem.
[edit] Bug Scrubs
We will be performing a weekly bug scrub to make sure the BZ is current and relevant. We will decide the ultimate priority/severity, but if you disagree please just post a comment and we will take your position into consideration.
[edit] Unknown Product / Component
The Product/Components in the BZ are organized for the most part by how our code base looks. If you are unsure of what Product/Component a defect should be filed against you may file it against the "Unknown Product" and "Unknown Component", we'll go through these during the bug scrub and all defects will be reassigned to their appropriate Product/Component.
[edit] Ownership
If you'd like to fix a bug please take NEW defects from robert.w.love@intel.com. Robert's account is the default owner for all bugs. He will move bugs from NEW to ASSIGNED when he's working on something. When you take ownership please switch the assignee to your name and set the state to ASSIGNED. This way everyone will know that you own this bug and are working on it.
[edit] Code Submission
When you've fixed a bug please provide the changes in the form of a patch file. We expect all kernel style conventions to be adhered to. Also when changing how building occurs please keep in mind that there are two build processes; the in kernel build (from within the -upstream repository) and our out-of-kernel (OOK) build which would occur from within the open-fcoe repository.
[edit] Format
We expect the following format for patches submitted to the devel@open-fcoe.org mailing list.
- Please post patches in the mail body, not as attachments.
- Please post with plain-text only.
- Please provide a "Signed-off" line.
- Please lead your patch description with the '[FCoE]' identifier. For example, "[FCoE] This patch fixes something". This allows us to easily keep track of patches for our code base and not the rest of the kernel.
[edit] Evolution
All contributors should keep in mind that this project is early in its development and all processes are evolving. Please stay flexible as this process will enviably change. Also keep in mind that we are trying to keep the process overhead as light as we can while providing our community all of the tools required for us all to work together and create the best FCoE project that we can.
[edit] Problems
Please file defects against any tools that we provide which you're having problems with, if you're stuck on something and filing a bug isn't appropriate please e-mail robert.w.love@intel.com for additional support.