HowToSubmitAPatch

Guidelines for submitting a patch to Calagator

**Labels:**Phase-Implementation

How To Submit a Patch

Step 1: Join the Calagator Development mailing list

http://groups.google.com/group/calagator-development

Step 2: Checkout the current stable source

$ git clone git://github.com/calagator/calagator.git
$ cd calagator

Step 3: Make your changes in a branch

$ git checkout -b useful_changes
Switched to a new branch "useful_changes"

As you make changes, commit them to your branch.

$ git commit -a -m "Fixing really annoying import bug for Issue 10203"

Step 4: Merge

$ git checkout master
Switched to branch "master"
$ git pull
...
$ git checkout useful_changes
Switched to branch "useful_changes"
$ git rebase master

Fix any conflicts.

Step 5: Check that your code meets the minimum requirements

• Follows basic style guidelines http://www.caliban.org/ruby/rubyguide.shtml#style / http://webstyleguide.com/
• Maintains 90% or higher spec coverage
• Corresponds to a ticket in the issue tracker
• Can be applied cleanly to the current stable release

If your patch does not follow these guidelines, it cannot be reviewed.

Step 6: Create a patch

$ git format-patch master --stdout > your-patch-file.patch

Step 7: Request review by notifying the mailing list and attaching the patch to the ticket

http://groups.google.com/group/calagator-development

Include the issue number in the title. Example: "[patch] Issue 4321: SourceParser should not explode when importing Swedish death metal concerts." Describe how your patch addresses the issue.

Edit the issue ticket to include your patch as an attachment, and change the status to PatchSubmitted.

Step 8: Wait for feedback

Patience, grasshopper.

Step 9: Feedback

Through discussion on the list, we'll decide whether the patch can be applied in the next stable release, needs more work, or belongs in a fork of the project due to differing goals.

INITIAL REVIEW NEEDED