User Tools

Site Tools


contributions

Contributions



Where to start?

There are a few places that an engineer should look when interested in contributing to Open-FCoE:

  • The Open-FCoE mailing list
  • The linux-scsi mailing list

linux-scsi

Open-FCoE was designed to be a Low Level Driver (LLD) of the Linux SCSI subsystem. We will discuss changes on fcoe-devel@open-fcoe.org, but all changes must be approved by the linux-scsi list and ultimately the Linux community before they are accepted into the kernel. Patches agreed upon by the Open-FCoE community will be collected and pushed to the linux-scsi mailing list at the appropriate times.

Reporting

At the time of this page's writing there is no formal process for reporting new defects. The easiest way to report a defect would be to mail fcoe-devel@open-fcoe.org.

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. Please ask on the development mailing list if you're not sure which repository to create your patch against.

Format

We expect the following format for patches submitted to the devel@open-fcoe.org mailing list.

  1. Please post patches in the mail body, not as attachments.
  2. Please post with plain-text only.
  3. Please provide a “Signed-off” line.
  4. Please prefix the title of your patch with something appropriate. For example, “libfc: This patch fixes something”. This allows us to easily keep track of patches for our code base and not the rest of the kernel. Investigate the 'git log' to see what other developers are using as prefixes.

man Pages

We use the 'a2x' command to convert an Asciidoc text file to both manpage format as well as other formats. If you are making changes to a man page please edit the corresponding .txt file in the doc/ directory. Next run 'make' which will run 'a2x' and generate the man page. Simply update your patch contribution with both the changes to the .txt file as well as the created .8 (man page) file. This process allows us to use the .txt file as the master document and all other formats are simply formatted versions of the original.

contributions.txt · Last modified: 2013/01/28 12:34 by rwlove