Submitting A Patch

From Koha Wiki
Jump to navigation Jump to search

Follow these steps to submit a patch to Koha:

  1. Create an entry in Bugzilla if it does not exist already. Don't forget to set the "Change sponsored" field if applicable. There is a default assignee for each component. If you plan to submit a patch yourself, please assign the bug to yourself and set the status to "ASSIGNED" (instead of NEW).
  2. Write your patch. Please follow the coding guidelines page.
  3. Write a detailed commit message and include a test plan.
  4. If your patch adds a feature that is sponsored by a library, don't forget to add 'Sponsored-by: xxxx' in your commit comments. This will detected during the release process and the xxxx will be thanked and credited.
  5. Format your patch. You can use our Git tutorial if you're new to git (skip this if you work with git bz).
  6. Attach your patch to the bug. You can do it through the web interface, or with git bz.
  7. Update status to "Needs signoff."
  8. Choose a value for "Patch complexity:"
    • String patch = a patch that touches a string or the documentation/POD only.
    • Trivial patch = a patch that just changes trivial things like removing a warn, adding some HTML in a template, etc.
    • Small patch = a patch that changes only a few Perl things.
    • Medium patch = a patch that changes many things, with a low to medium risk of side-effects, no or small DB changes.
    • Large patch = a patch that changes many things with a high side-effect risk, large DB change.

Now, you just have to wait for someone taking care of your patch (sign-off and QA) If you need help or want to find someone to test your patch jump on our IRC channel and ask here.