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

Ginger Project uses Git to source versioning/controlling/management, and it's 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/ginger.git

To get the latest updates you only need to execute:

$ git pull

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

Submitting changes

All patches are sent through our development mailing list hosted at ginger-dev-list@googlegroups.com.

Patches should be sent using git-send-email (use your Linux distro 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):

[alias]
    makepatch = format-patch --subject-prefix=\"PATCH] [Ginger\" --cover-letter
    askreview = send-email --no-signed-off-cc --smtp-server <your SMTP server> --from \"<your email address>\" --thread –annotate
[sendemail]
    to = Ginger Devel <ginger-dev-list@googlegroups.com>
    suppresscc = all

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.