Skip to content
This repository has been archived by the owner on Mar 22, 2021. It is now read-only.

Patch Mailing policy

Jump to bottom
erikb85 edited this page Dec 19, 2012 · 4 revisions

Introduction

If you want to interact with the MONK developers, you can write an email to project-monk@dresearch-fe.de. There are some things to remember, when writing at our mailing list, you should follow the following rules:

  • Write in English, always. Although most of our developers are German mother-tongue speakers, this project should appeal to an international audience.
  • Explain your ideas in a clean and explicit manner.
  • When presenting patches, you can either use pull requests or you can use [git send-mail]. The details about formatting and a small HOWTO can be found below this list.

Patch mailing Guide

1. Prepare your .gitconfig:

At least you have to write an smtp server and it's port. Depending on where you want to connect to, you might need other options as well. See the help for git-send-email for further details.

    [sendemail]
        smtpserver = smtp.your-server.com
        smtpserverport = 25

2. Prepare your commits:

At first you should locally commit your changes as wished to your tree, beginning from the commit, where you want other people to appl your changes to.

3. Create your patch emails:

To create patch files in Email format the tool git format-patch is used. For the MONK ML it is nessesary to apply the following arguments: --thread --cover-letter

4. Change your patch files:

The patch files are now filled with your commits, your diffs and an additional 0000-* file, which will be your cover letter. While the patch files should all be filled correctly, if your commits were written okay, your cover letter still needs to get filled with a subject and a message body, explaining what your commits are about. This is also a good time to change the commits itself, iif you found any spelling errors and the like.

5. Sending them out:

Now sending them just requires one more command. Here sometimes errors occur which most likely come from your configuration.

git send-email --from <who-are-you> --to project-monk@dreserach-fe.de --thread --no-chain-reply-to <the-commits>

Clone this wiki locally