From dev-return-32142-archive-asf-public=cust-asf.ponee.io@geode.apache.org Tue Oct 8 14:44:45 2019 Return-Path: X-Original-To: archive-asf-public@cust-asf.ponee.io Delivered-To: archive-asf-public@cust-asf.ponee.io Received: from mail.apache.org (hermes.apache.org [207.244.88.153]) by mx-eu-01.ponee.io (Postfix) with SMTP id 46EEB180654 for ; Tue, 8 Oct 2019 16:44:45 +0200 (CEST) Received: (qmail 90393 invoked by uid 500); 8 Oct 2019 14:44:44 -0000 Mailing-List: contact dev-help@geode.apache.org; run by ezmlm Precedence: bulk List-Help: List-Unsubscribe: List-Post: List-Id: Reply-To: dev@geode.apache.org Delivered-To: mailing list dev@geode.apache.org Received: (qmail 90372 invoked by uid 99); 8 Oct 2019 14:44:44 -0000 Received: from pnap-us-west-generic-nat.apache.org (HELO spamd4-us-west.apache.org) (209.188.14.142) by apache.org (qpsmtpd/0.29) with ESMTP; Tue, 08 Oct 2019 14:44:44 +0000 Received: from localhost (localhost [127.0.0.1]) by spamd4-us-west.apache.org (ASF Mail Server at spamd4-us-west.apache.org) with ESMTP id AD725C22A0 for ; Tue, 8 Oct 2019 14:44:43 +0000 (UTC) X-Virus-Scanned: Debian amavisd-new at spamd4-us-west.apache.org X-Spam-Flag: NO X-Spam-Score: 1.301 X-Spam-Level: * X-Spam-Status: No, score=1.301 tagged_above=-999 required=6.31 tests=[HTML_MESSAGE=2, RCVD_IN_DNSWL_LOW=-0.7, SPF_HELO_NONE=0.001, SPF_PASS=-0.001, URIBL_BLOCKED=0.001] autolearn=disabled Received: from mx1-he-de.apache.org ([10.40.0.8]) by localhost (spamd4-us-west.apache.org [10.40.0.11]) (amavisd-new, port 10024) with ESMTP id CxnIg6_jQzHA for ; Tue, 8 Oct 2019 14:44:41 +0000 (UTC) Received-SPF: Pass (mailfrom) identity=mailfrom; client-ip=148.163.150.38; helo=mx0a-00296801.pphosted.com; envelope-from=jramos@pivotal.io; receiver= Received: from mx0a-00296801.pphosted.com (mx0a-00296801.pphosted.com [148.163.150.38]) by mx1-he-de.apache.org (ASF Mail Server at mx1-he-de.apache.org) with ESMTPS id 335D17DDE0 for ; Tue, 8 Oct 2019 14:44:40 +0000 (UTC) Received: from pps.filterd (m0114581.ppops.net [127.0.0.1]) by mx0a-00296801.pphosted.com (8.16.0.42/8.16.0.42) with SMTP id x98EQLpC023640 for ; Tue, 8 Oct 2019 14:44:38 GMT Received: from mail-ed1-f72.google.com (mail-ed1-f72.google.com [209.85.208.72]) by mx0a-00296801.pphosted.com with ESMTP id 2vg2vn18u5-1 (version=TLSv1.2 cipher=ECDHE-RSA-AES128-GCM-SHA256 bits=128 verify=NOT) for ; Tue, 08 Oct 2019 14:44:38 +0000 Received: by mail-ed1-f72.google.com with SMTP id o92so11353350edb.9 for ; Tue, 08 Oct 2019 07:44:38 -0700 (PDT) X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:mime-version:references:in-reply-to:from:date :message-id:subject:to; bh=sbqDr42b5iOrWdLsihULolJbnzIlEKsCSu/0hP05lBY=; b=mF5jKqua+sXyGq7AAKAAP+o7Ly05Bni9P1PjaVzSZLHpfaosV0CwcHpQTlyOL9JTN4 FOUDD1JSZKX1XBVcTgW3mwq9SYbTs43ud6GFAMGdf5tP/f2EBxRO/loYEw/v26tLReQR eo0faKS2BKLvnnRKmGdiMuE+bUuG11ww5CXnhgF8vcgUx3ADBScECNqSRwxopaIetS51 +q1E9KQdGpYVPqHYAtqAz/5u0Y2c20nLbQuvP1M9njVdXbKlpcAJpauDfMh6aJe8n7xX PgO/kdiF+rycGlNj57rH2diw+Z9Rp8OfLRSYg8yclKwCwj7rAbOi+eMlZlXc+rSNeBec xrdg== X-Gm-Message-State: APjAAAXQrmSHWwaX6s0+h1HigmprEQg/Vkz+MU8F6YKYEsfxefzVu+Mj TMkO3j0IgDHA84Hfsrr/d7mtD+picPq92gMHvrENHxifUY4zDB1vzfnpVcubOy6mxQqfmbPd+UV Q2SPpK08pmVX7vYTcYUC24kjEcUTvkZOL7jwzpdCzxu6DPlTsiiX29yQ= X-Received: by 2002:a50:ed17:: with SMTP id j23mr33971026eds.248.1570545876057; Tue, 08 Oct 2019 07:44:36 -0700 (PDT) X-Google-Smtp-Source: APXvYqzYwbgqTZBf24fwbfzaec41x82dPjy2f+aGOwFpLwdFwhE7Sg4aj4fqKxC4aaD/zEi085DueZyaX7GUajB3agA= X-Received: by 2002:a50:ed17:: with SMTP id j23mr33970998eds.248.1570545875697; Tue, 08 Oct 2019 07:44:35 -0700 (PDT) MIME-Version: 1.0 References: In-Reply-To: From: =?UTF-8?Q?Juan_Jos=C3=A9_Ramos?= Date: Tue, 8 Oct 2019 15:44:24 +0100 Message-ID: Subject: Re: [DISCUSS]: Commit Message Format too Short? To: dev@geode.apache.org Content-Type: multipart/alternative; boundary="000000000000065f3f05946735bf" X-Proofpoint-Virus-Version: vendor=fsecure engine=2.50.10434:6.0.95,1.0.8 definitions=2019-10-08_05:2019-10-08,2019-10-08 signatures=0 X-Proofpoint-Spam-Details: rule=notspam policy=default score=0 bulkscore=0 mlxscore=0 lowpriorityscore=0 mlxlogscore=999 suspectscore=0 malwarescore=0 priorityscore=1501 clxscore=1015 phishscore=0 adultscore=0 impostorscore=0 spamscore=0 classifier=spam adjust=0 reason=mlx scancount=1 engine=8.12.0-1908290000 definitions=main-1910080133 --000000000000065f3f05946735bf Content-Type: text/plain; charset="UTF-8" Content-Transfer-Encoding: quoted-printable Yes, the 50 chars cap rule is *only for the subject of the commit message*. The actual body of the commit message should contain all the details, with a maximum of 72 characters per line. Example: *GEODE-XXX: 50 chars or less summary - [Commit Message Subject]Blank lineMore details about the commit, the why, the changes, capped to 72 - [Commit Message Body - Line1]chars per line. - [Commit Message Body - Line2]* *More details. - [Commit Message Body - Line3]* *...* *Yet more details. - [Commit Message Body - LineN]* Cheers. On Tue, Oct 8, 2019 at 3:37 PM Ernest Burghardt wrote: > Isn't this only regarding the "headline" commit message, but there can be > sub-bulletted text further describing the commit in greater detail...? > This is how I have always interpreted this business... > > EB > > On Tue, Oct 8, 2019 at 3:58 AM Alberto Bustamante Reyes > wrote: > > > I think its a good idea to have an automatic mechanism to reject commit= s > > that exceed a given limit. > > In the previous project I was assigned we used Gerrit instead of Github= , > > and we had an automatic check to vote -1 if your commit message exceede= d > > the limit. > > > > Anyway, while this is decided, a quick action could be to add a new lin= e > > to the PR template, at least to remember it: > > > > - [ ] Is your commit message length below the limit of 50 characters? > > > > > > > > > > > > ________________________________ > > De: Juan Jos=C3=A9 Ramos > > Enviado: martes, 8 de octubre de 2019 11:32 > > Para: dev@geode.apache.org > > Asunto: Re: [DISCUSS]: Commit Message Format too Short? > > > > Hello Owen, > > > > Yes, I fully agree with you. And just to be clear, I wasn't trying to > > discourage descriptive commit messages, on the contrary, we certainly > must > > encourage them at all cost!!. It was decided that we should, however, t= ry > > to keep consistency across all commits and make the subject brief, addi= ng > > the full details within the body of the text; as described in *How to > write > > a Git commit message [1], *referenced in our *Commit Message Format > > [2] *article. > > Right now we're not enforcing this rule, there are even some commits > > without the ticket number at the beginning of the commit subject :-/. > > I guess the goal of this thread is to gather some feedback and opinions > > from the community to better decide how to proceed: remove the rule, > > increase the maximum amount of characters from 50 to something else in > the > > commit message subject, automatically enforce the rule altogether and > > prevent commits that don't follow it, etc. > > Best regards. > > > > [1]: https://chris.beams.io/posts/git-commit/ > > [2]: > > https://cwiki.apache.org/confluence/display/GEODE/Commit+Message+Format > > > > On Tue, Oct 8, 2019 at 10:07 AM Owen Nichols > wrote: > > > > > I don=E2=80=99t care how long it is, but knowing that many tools show= only the > > > first bit, it=E2=80=99s helpful if the message is phrased with the mo= st > important > > > words near the beginning. > > > > > > I=E2=80=99d much prefer to encourage rather than discourage descripti= ve commit > > > messages. Even better if all commit messages mentioned more about _wh= y_ > > the > > > change is being made, not just describe the diff. > > > > > > But most important of all, NEVER forget the colon between the ticket > > number > > > and the rest. I learned that the hard way :( > > > > > > -Owen > > > > > > On Tue, Oct 8, 2019 at 1:52 AM Ju@N wrote: > > > > > > > Hello devs, > > > > > > > > I've notice that, lately, not everybody is following the guidelines > we > > > have > > > > highlighted in our Wiki under *Commit Message Format [1]*, speciall= y > > the > > > > first requirement: *GEODE-nn: Capitalized, 50 chars or less summary= . > > *As > > > an > > > > example, out of the last 33 commits in develop, only 11 follow the = 50 > > > chars > > > > max rule. > > > > Even though I've always followed this "rule", I often find it hard = to > > > > provide a summary of the commit in less than 50 chars, that's > probably > > > the > > > > reason why other people are just ignoring this part of the > guidelines?. > > > > Should we increase the maximum amount of characters from 50 to > > something > > > > else?, should we add a hard check in order to automatically enforce > the > > > > rule?, should we delete the rule altogether?, thoughts?. > > > > Best regards. > > > > > > > > [1]: > > > > > > https://cwiki.apache.org/confluence/display/GEODE/Commit+Message+Format > > > > > > > > -- > > > > Ju@N > > > > > > > > > > > > > -- > > Juan Jos=C3=A9 Ramos Cassella > > Senior Software Engineer > > Email: jramos@pivotal.io > > > --=20 Juan Jos=C3=A9 Ramos Cassella Senior Software Engineer Email: jramos@pivotal.io --000000000000065f3f05946735bf--