How to submit a patch

Mon, 12/21/2009 - 07:13 | by einderri

Try to keep your patches specific to a single change, and ensure that your change does not break any tests. Do this by running

  make test

If there is no test for the fixed bug, please try to provide one.

The preferred method of creating a patch is to use the current head of master in the EFS git repository. This ensures that the patch works with the most recent EFS source code, and makes it easier for the EFS team to apply the patch.

Using git

  1. Clone the repository

  git clone git@git.openefs.org:efs-core.git
  2. Modify the source to correct the bug. Commit your changes to the cloned repository. Make sure all tests pass.

  $ cd efs
  # ...modify code...
  $ git commit -a
  3. Generate your patch with git format-patch.

  $ git format-patch origin/master
  # generates a patch file (e.g. 0001-foo.patch)
  4. Submit the patch by attaching to a ticket, or sending to the development mailing list.

The AUTHORS file

Each and every patch is an important contribution to EFS and it’s important that these efforts are recognized. To that end, the Authors file contains an informal list of contributors and their contributions made to EFS. Patch submitters are encouraged to include a new or updated entry for themselves in AUTHORS as part of their patch.The format for entries in AUTHORS is defined at the top of the file.

  1. Go to the EFS ticket tracking system . Log in, or create an account if you don’t have one yet.
  2. Select New Ticket.
  3. Give a clear and concise summary. Prefix it with a “[PATCH]”  identifier.
  4. In the description, explain of the purpose of the patch and list files affected. 5. Set the Type of the ticket to “improvement”. Set other relevant drop-down menus, such as the version (the version of EFS where you encountered the problem).
  5. Check the box for “I have files to attach to this ticket” Double-check that you’ve actually done this, because it’s easy to forget. DO NOT paste the patch file content into the Description.
  6. Click the “Create ticket” button. On the next page attach your patch file(s).