Re: [Ietf-and-github] WGLC for draft-ietf-git-using-github

"Salz, Rich" <rsalz@akamai.com> Tue, 03 December 2019 18:56 UTC

Return-Path: <rsalz@akamai.com>
X-Original-To: ietf-and-github@ietfa.amsl.com
Delivered-To: ietf-and-github@ietfa.amsl.com
Received: from localhost (localhost [127.0.0.1]) by ietfa.amsl.com (Postfix) with ESMTP id 883F712000F for <ietf-and-github@ietfa.amsl.com>; Tue, 3 Dec 2019 10:56:21 -0800 (PST)
X-Virus-Scanned: amavisd-new at amsl.com
X-Spam-Flag: NO
X-Spam-Score: -2.701
X-Spam-Level:
X-Spam-Status: No, score=-2.701 tagged_above=-999 required=5 tests=[BAYES_00=-1.9, DKIMWL_WL_HIGH=-0.001, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, RCVD_IN_DNSWL_LOW=-0.7, SPF_HELO_NONE=0.001, SPF_PASS=-0.001] autolearn=ham autolearn_force=no
Authentication-Results: ietfa.amsl.com (amavisd-new); dkim=pass (2048-bit key) header.d=akamai.com
Received: from mail.ietf.org ([4.31.198.44]) by localhost (ietfa.amsl.com [127.0.0.1]) (amavisd-new, port 10024) with ESMTP id t32bC_A4YQfo for <ietf-and-github@ietfa.amsl.com>; Tue, 3 Dec 2019 10:56:20 -0800 (PST)
Received: from mx0b-00190b01.pphosted.com (mx0b-00190b01.pphosted.com [IPv6:2620:100:9005:57f::1]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by ietfa.amsl.com (Postfix) with ESMTPS id F31E212082D for <ietf-and-github@ietf.org>; Tue, 3 Dec 2019 10:56:18 -0800 (PST)
Received: from pps.filterd (m0122330.ppops.net [127.0.0.1]) by mx0b-00190b01.pphosted.com (8.16.0.42/8.16.0.42) with SMTP id xB3IrEpm003176; Tue, 3 Dec 2019 18:56:15 GMT
DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=akamai.com; h=from : to : subject : date : message-id : references : in-reply-to : content-type : content-id : content-transfer-encoding : mime-version; s=jan2016.eng; bh=R7+OtJqhqgwY4EkEk/U81ykZTvLRhAgbvAbptwwpXaU=; b=Hm5J72+bzhW6TF7UKFGInkCYTLftNQx4sb3U/5SBjHFlyCQVBpAMyCY3kCizwv/QHgE1 dt8/YiNkhf76aDIF8f2mPSmuyYrMVF0RdXHGSBVS2begfhuJKfXy1/YoRJ1Df54e3Rz+ dviHQ8NbW7sGHC5VDeu8XBt+eIfzlIDS7FooBwc4NkHo450QZS7CETg5J1mvqkL704zN KMoCnh6ay4gnH5nSazZlD1wUItVM9l0e3DCuYpU0rQHmE6rHqd9UjJADlhIXx7NdeD1r PRtJeqzJJc+3tveR6QIDyyJRQnymDJeDG0KyMB2cIP15tErHb+zs5uFshnJqRGBW4XuN 1w==
Received: from prod-mail-ppoint1 (prod-mail-ppoint1.akamai.com [184.51.33.18] (may be forged)) by mx0b-00190b01.pphosted.com with ESMTP id 2wnkemt0xk-1 (version=TLSv1.2 cipher=ECDHE-RSA-AES256-GCM-SHA384 bits=256 verify=NOT); Tue, 03 Dec 2019 18:56:15 +0000
Received: from pps.filterd (prod-mail-ppoint1.akamai.com [127.0.0.1]) by prod-mail-ppoint1.akamai.com (8.16.0.27/8.16.0.27) with SMTP id xB3IqUWW006871; Tue, 3 Dec 2019 13:56:15 -0500
Received: from email.msg.corp.akamai.com ([172.27.123.33]) by prod-mail-ppoint1.akamai.com with ESMTP id 2wkmmyknt3-1 (version=TLSv1.2 cipher=ECDHE-RSA-AES256-SHA384 bits=256 verify=NOT); Tue, 03 Dec 2019 13:56:14 -0500
Received: from USMA1EX-DAG1MB3.msg.corp.akamai.com (172.27.123.103) by usma1ex-dag1mb2.msg.corp.akamai.com (172.27.123.102) with Microsoft SMTP Server (TLS) id 15.0.1473.3; Tue, 3 Dec 2019 13:56:14 -0500
Received: from USMA1EX-DAG1MB3.msg.corp.akamai.com ([172.27.123.103]) by usma1ex-dag1mb3.msg.corp.akamai.com ([172.27.123.103]) with mapi id 15.00.1473.005; Tue, 3 Dec 2019 13:56:13 -0500
From: "Salz, Rich" <rsalz@akamai.com>
To: Christopher Wood <caw@heapingbits.net>, "ietf-and-github@ietf.org" <ietf-and-github@ietf.org>
Thread-Topic: [Ietf-and-github] WGLC for draft-ietf-git-using-github
Thread-Index: AQHVnrpvkpy5GlIwgkm0sasVjMmEHaeo2TQA
Date: Tue, 03 Dec 2019 18:56:13 +0000
Message-ID: <E192F154-C83A-46FE-AE4D-149F02C7D287@akamai.com>
References: <d61508a2-74c0-448b-94a0-52d8b0f64285@www.fastmail.com>
In-Reply-To: <d61508a2-74c0-448b-94a0-52d8b0f64285@www.fastmail.com>
Accept-Language: en-US
Content-Language: en-US
X-MS-Has-Attach:
X-MS-TNEF-Correlator:
user-agent: Microsoft-MacOutlook/10.20.0.191202
x-ms-exchange-messagesentrepresentingtype: 1
x-ms-exchange-transport-fromentityheader: Hosted
x-originating-ip: [172.19.82.100]
Content-Type: text/plain; charset="utf-8"
Content-ID: <14549888D429CD4EAB3B8901B5033E45@akamai.com>
Content-Transfer-Encoding: base64
MIME-Version: 1.0
X-Proofpoint-Virus-Version: vendor=fsecure engine=2.50.10434:, , definitions=2019-12-03_06:, , signatures=0
X-Proofpoint-Spam-Details: rule=notspam policy=default score=0 suspectscore=0 malwarescore=0 phishscore=0 bulkscore=0 spamscore=0 mlxscore=0 mlxlogscore=999 adultscore=0 classifier=spam adjust=0 reason=mlx scancount=1 engine=8.0.1-1911140001 definitions=main-1912030139
X-Proofpoint-Virus-Version: vendor=fsecure engine=2.50.10434:6.0.95,18.0.572 definitions=2019-12-03_06:2019-12-02,2019-12-03 signatures=0
X-Proofpoint-Spam-Details: rule=notspam policy=default score=0 mlxscore=0 bulkscore=0 impostorscore=0 phishscore=0 suspectscore=0 malwarescore=0 clxscore=1015 mlxlogscore=999 lowpriorityscore=0 spamscore=0 adultscore=0 priorityscore=1501 classifier=spam adjust=0 reason=mlx scancount=1 engine=8.12.0-1910280000 definitions=main-1912030138
Archived-At: <https://mailarchive.ietf.org/arch/msg/ietf-and-github/s4RPRjk9t43U18Zub6jzlw7AK2M>
Subject: Re: [Ietf-and-github] WGLC for draft-ietf-git-using-github
X-BeenThere: ietf-and-github@ietf.org
X-Mailman-Version: 2.1.29
Precedence: list
List-Id: "Discussion of using GitHub in IETF activities, particularly for Working Groups" <ietf-and-github.ietf.org>
List-Unsubscribe: <https://www.ietf.org/mailman/options/ietf-and-github>, <mailto:ietf-and-github-request@ietf.org?subject=unsubscribe>
List-Archive: <https://mailarchive.ietf.org/arch/browse/ietf-and-github/>
List-Post: <mailto:ietf-and-github@ietf.org>
List-Help: <mailto:ietf-and-github-request@ietf.org?subject=help>
List-Subscribe: <https://www.ietf.org/mailman/listinfo/ietf-and-github>, <mailto:ietf-and-github-request@ietf.org?subject=subscribe>
X-List-Received-Date: Tue, 03 Dec 2019 18:56:22 -0000

Some comments I'd like to see addressed before existing WGLC.

I dislike the draft's use of the word "proven," and would prefer constructs like "demonstrably" or "shown to be" etc.  I could live with the others, but the use in the Introduction section really needs to be fixed.  I guess my dislike is that it could be taken by some as being needless confrontational, and we've already proven (heh) that this topic has some controversy.

The phrase "source control" in the Intro should be "version control"

 Near the end of page 3 (pagination in text format, sorry not sorry :) the phrase "avoid issues" should be "help WG chairs avoid issues" I think.

Sec 1.1 should explain why this is cool.  It allows several types of workflow to be used and changed. For example, authors collaborating, pushing changes to a WG repo, etc.

Sec 1.3 "bitbuckey *and* gitlab"

Sec 2.1, I prefer "ietf-wg-XXXX", top-down style, not intermixed.  Blue bikesheds rule. But it also follows the draft-ietf-<wg>- naming style.

Sec 3.1, Last sentence, about link from README to CONTRIBUTING. Should that be a SHOULD and written in active-voice?
At the end of 3.1, can you give an "anti-pattern" (we used to say counter-example I guess) of what would be something unfustifiably constraining?

Sec 3.2, "draft-ietf-<wg>-" should that be "draft-ietf-<wgname>-" ? I think using one term throughout is better.

Sec 3.3 "unless with prior..." reads better as "without prior" I think.

Sec 4.1.2 if restrictions on closing are changed, is this a change in policy that must be communicated and the WG agree to? Or is this something to include in the initial policy and if so, is there guidance in this document for that?

Sec 4.2  Should this mention that PR's can be updated by pushing new commits to the originating repo?  This lets PR's evolve in response to WG discussion.

Sec 4.3 "requires *email* server infrastructure" ?

Sec 5.2, near the end.  :communication about the work of the group from the *Working Group* mailing list." ?

Sec 5.4.1, flip the design and editorial pragraphs?  Matches the structure of increasing difficulty?  Not a big deal, freel free to ignore.

Sec 6, makes the document available "to a wider *IETF* audience" ?

Sec 7, top of page 19.  "If permitted" maybe mention "by the Working Group policy" ?  Fine if you think that's redundant.

Sec 8, "changes to a document" should be "repository" ? Add "These services are generally available at no cost" ?

Sec 9 uses "you" language. Should that change to "Editor" language? "Create a new issue for them"  And add a comment pointing to the issue and directing discussion there?

Sec 10.  Ha.

Sec 13.  Gh-config appears both normative and non-nomative

Sec A2 top of p	25  No "seem to lose" about it.  The lose sender info, which makes it useless.

Appendix B needs to add authors for A3 and A4