How to Contribute

• Getting the source code
• Submitting changes
• git-sendemail configuration
• Commit changes locally
• Create the patch files
• Send patch to the mailing list
• Getting your contribution accepted

Getting the source code

Kimchi Project uses Git for source versioning/controlling/management, and its remote and official repository is hosted at GitHub. To clone the source code into your local repository, you only need to execute this command:

$ git clone https://github.com/kimchi-project/kimchi.git

To get the latest updates you only need to execute:

$ git pull

Need documentation about how to use Git? See this documentation.

Kimchi is also a git-submodule of Wok repository (https://github.com/kimchi-project/wok). To work with Kimchi and git-submodule, please, get instructions at: https://github.com/kimchi-project/wok/wiki/How-to-Work-with-Wok-Submodules

Submitting changes

All patches are sent through our development mailing list hosted at oVirt Project. More information can be found at:

http://lists.ovirt.org/mailman/listinfo/kimchi-devel

Make sure to subscribe to mailing list prior to send patches. Otherwise, your patches will not be delivered.

Patches should be sent using git-send-email (use your Linux distribution package manager to get it). A good point of start is described in the steps bellow:

git-sendemail configuration

Add into .git/config file the following content (modify the content between <greater-than and less-than signs> with your personal information):

IMPORTANT: If you are working with Wok and submodules, the right file to be updated is .git/modules/src/wok/plugins/kimchi/config

[alias]
    makepatch = format-patch --subject-prefix=\"PATCH] [Kimchi\" --cover-letter
    askreview = send-email --no-signed-off-cc --smtp-server <your SMTP server> --from \"<your email address>\" --thread --annotate 
[sendemail]
    to = Kimchi Devel <kimchi-devel@ovirt.org>
    cc = Aline Manera <aline.manera@gmail.com>
    suppresscc = all
    assume8bitEncoding = UTF-8

This content is setting up two new Git aliases into your local repository configuration: makepatch and askreview. The first alias should be used to create patch files to be sent to community review (details how to use in subsection 3). The second alias should be used to send the patch to development mailing list (details how to use in subsection 4). In addition, the section [sendemail] sets up the addresses and arguments to be used by the askreview alias.