Return-Path: X-Original-To: apmail-calcite-dev-archive@www.apache.org Delivered-To: apmail-calcite-dev-archive@www.apache.org Received: from mail.apache.org (hermes.apache.org [140.211.11.3]) by minotaur.apache.org (Postfix) with SMTP id 1D2DE18BA8 for ; Thu, 30 Jul 2015 05:34:39 +0000 (UTC) Received: (qmail 20946 invoked by uid 500); 30 Jul 2015 05:34:39 -0000 Delivered-To: apmail-calcite-dev-archive@calcite.apache.org Received: (qmail 20886 invoked by uid 500); 30 Jul 2015 05:34:39 -0000 Mailing-List: contact dev-help@calcite.incubator.apache.org; run by ezmlm Precedence: bulk List-Help: List-Unsubscribe: List-Post: List-Id: Reply-To: dev@calcite.incubator.apache.org Delivered-To: mailing list dev@calcite.incubator.apache.org Received: (qmail 20875 invoked by uid 99); 30 Jul 2015 05:34:38 -0000 Received: from Unknown (HELO spamd1-us-west.apache.org) (209.188.14.142) by apache.org (qpsmtpd/0.29) with ESMTP; Thu, 30 Jul 2015 05:34:38 +0000 Received: from localhost (localhost [127.0.0.1]) by spamd1-us-west.apache.org (ASF Mail Server at spamd1-us-west.apache.org) with ESMTP id 840E4D8A8A for ; Thu, 30 Jul 2015 05:34:38 +0000 (UTC) X-Virus-Scanned: Debian amavisd-new at spamd1-us-west.apache.org X-Spam-Flag: NO X-Spam-Score: -0.427 X-Spam-Level: X-Spam-Status: No, score=-0.427 tagged_above=-999 required=6.31 tests=[KAM_LAZY_DOMAIN_SECURITY=1, RP_MATCHES_RCVD=-1.428, URIBL_BLOCKED=0.001] autolearn=disabled Received: from mx1-us-west.apache.org ([10.40.0.8]) by localhost (spamd1-us-west.apache.org [10.40.0.7]) (amavisd-new, port 10024) with ESMTP id k1rn66BZ71A1 for ; Thu, 30 Jul 2015 05:34:29 +0000 (UTC) Received: from mail.apache.org (hermes.apache.org [140.211.11.3]) by mx1-us-west.apache.org (ASF Mail Server at mx1-us-west.apache.org) with SMTP id 2813E211CD for ; Thu, 30 Jul 2015 05:34:29 +0000 (UTC) Received: (qmail 20802 invoked by uid 99); 30 Jul 2015 05:34:28 -0000 Received: from mail-relay.apache.org (HELO mail-relay.apache.org) (140.211.11.15) by apache.org (qpsmtpd/0.29) with ESMTP; Thu, 30 Jul 2015 05:34:28 +0000 Received: from mail-wi0-f169.google.com (mail-wi0-f169.google.com [209.85.212.169]) by mail-relay.apache.org (ASF Mail Server at mail-relay.apache.org) with ESMTPSA id 8E3C01A0040 for ; Thu, 30 Jul 2015 05:34:28 +0000 (UTC) Received: by wibxm9 with SMTP id xm9so228417381wib.0 for ; Wed, 29 Jul 2015 22:34:26 -0700 (PDT) MIME-Version: 1.0 X-Received: by 10.180.188.139 with SMTP id ga11mr2454690wic.87.1438234466808; Wed, 29 Jul 2015 22:34:26 -0700 (PDT) Received: by 10.194.15.137 with HTTP; Wed, 29 Jul 2015 22:34:26 -0700 (PDT) Date: Wed, 29 Jul 2015 22:34:26 -0700 Message-ID: Subject: The art of the commit comment From: Julian Hyde To: dev@calcite.incubator.apache.org Content-Type: text/plain; charset=UTF-8 I thought I'd clarify the policy for commit comments when you (a committer) are checking in someone else's change (from a pull request or patch). The policy is: 0. The first line of the commit comment (called the "commit line") is the most important. Make it short and descriptive[1]. 1. If there is a corresponding jira case (and there should be, unless the change is trivial), the commit line must be the case number in square brackets followed by the case summary. Change the description of the jira case, if necessary, to comply with point #0. 2. Give the author credit at the end of the commit line if they are not a committer. 3. Follow the commit line by a blank line, and any extra remarks about the change. 4. If the contribution came via a pull request, add a line instructing github to close the pull request. Here is a commit that illustrates all of these points: https://git1-us-west.apache.org/repos/asf?p=incubator-calcite.git;a=commit;h=468a161bbd8fd4994085d96e2bc801209a17cf76 Julian [1] http://chris.beams.io/posts/git-commit/