From mboxrd@z Thu Jan 1 00:00:00 1970 Received: from us-smtp-1.mimecast.com (us-smtp-1.mimecast.com [207.211.31.120]) by mx.groups.io with SMTP id smtpd.web12.17824.1597248062467724187 for ; Wed, 12 Aug 2020 09:01:02 -0700 Authentication-Results: mx.groups.io; dkim=pass header.i=@redhat.com header.s=mimecast20190719 header.b=d3VunX1d; spf=pass (domain: redhat.com, ip: 207.211.31.120, mailfrom: crobinso@redhat.com) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1597248061; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:cc:mime-version:mime-version:content-type:content-type: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references; bh=4FwKfpH8METXMhuq7ofaEnESMWn9zqJ6AEGJBXrkxnQ=; b=d3VunX1dqV10lsmfU3p7/0EWa+fyd4ooZbCzZND6HU3knlGVjlC5+HDv46GYqILXytf6YE 2qrmjdgVnPhCfHS2LqYkUt87n1u270vC7VDvDYHwGuWbrVbP+BIfuL9FVf0Ub3SulC32zP +/+trfiWr7XYAf42Zvq/Uus200biCW0= Received: from mimecast-mx01.redhat.com (mimecast-mx01.redhat.com [209.132.183.4]) (Using TLS) by relay.mimecast.com with ESMTP id us-mta-353-v9r27a2qOxyZHUYdNT4esQ-1; Wed, 12 Aug 2020 12:00:44 -0400 X-MC-Unique: v9r27a2qOxyZHUYdNT4esQ-1 Received: from smtp.corp.redhat.com (int-mx03.intmail.prod.int.phx2.redhat.com [10.5.11.13]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by mimecast-mx01.redhat.com (Postfix) with ESMTPS id 1FCB2100854A; Wed, 12 Aug 2020 16:00:42 +0000 (UTC) Received: from [10.10.117.41] (ovpn-117-41.rdu2.redhat.com [10.10.117.41]) by smtp.corp.redhat.com (Postfix) with ESMTP id 72CEE60C2A; Wed, 12 Aug 2020 16:00:41 +0000 (UTC) Subject: Re: [PATCH] Add a stub CONTRIBUTING.md pointing to the wiki To: Laszlo Ersek , devel@edk2.groups.io Cc: michael.d.kinney@intel.com, "Leif Lindholm (Nuvia address)" , Andrew Fish References: <06fed550-e96a-4a12-7550-22156cb8a414@redhat.com> <01274196-2b38-74ef-6653-b48b2b46d845@redhat.com> From: "Cole" Message-ID: <9d611414-3a9a-2c4c-2b9f-56b72e2cc250@redhat.com> Date: Wed, 12 Aug 2020 12:00:41 -0400 User-Agent: Mozilla/5.0 (X11; Linux x86_64; rv:60.0) Gecko/20100101 Thunderbird/60.8.0 MIME-Version: 1.0 In-Reply-To: <01274196-2b38-74ef-6653-b48b2b46d845@redhat.com> X-Scanned-By: MIMEDefang 2.79 on 10.5.11.13 Authentication-Results: relay.mimecast.com; auth=pass smtp.auth=CUSA124A263 smtp.mailfrom=crobinso@redhat.com X-Mimecast-Spam-Score: 0 X-Mimecast-Originator: redhat.com Content-Language: en-US Content-Type: text/plain; charset=us-ascii Content-Transfer-Encoding: 7bit On 8/12/20 5:37 AM, Laszlo Ersek wrote: > On 08/12/20 00:51, Cole Robinson wrote: >> On 8/11/20 5:55 PM, Laszlo Ersek wrote: >>> On 08/11/20 20:09, Cole Robinson wrote: >>>> Googling for 'edk2 pull request' did not find this wiki page: >>>> >>>> https://github.com/tianocore/tianocore.github.io/wiki/EDK-II-Development-Process >>>> >>>> Add it to CONTRIBUTING.md for more discoverability >>>> >>>> Signed-off-by: Cole Robinson >>>> --- >>>> I tried submitting a PR to edk2: https://github.com/tianocore/edk2/pull/854 >>>> >>>> It was auto closed with: `All checks passed. Auto close personal build.` >>>> >>>> That confused me quite a bit. I could not understand what it was trying >>>> to say. I looked at other successfully merged PRs, noticed some hits >>>> about a 'push' label, but on looking to resubmit the PR it didn't seem >>>> like I had permission to set labels. Googling did not turn up any explanatory >>>> hits in the first two pages either. Eventually Laszlo pointed me in the >>>> right direction though >>>> >>>> A couple other suggestions to avoid that confusion >>>> >>>> * Extend the mergify message to clarify PRs are largely only meant for >>>> maintainers to use. Maybe point at the wiki page or CONTRIBUTING.md >>>> >>>> * Add a github new PR template with a comment giving more explanation: >>>> https://docs.github.com/en/github/building-a-strong-community/creating-a-pull-request-template-for-your-repository >>>> >>>> CONTRIBUTING.md | 3 +++ >>>> 1 file changed, 3 insertions(+) >>>> create mode 100644 CONTRIBUTING.md >>>> >>>> diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md >>>> new file mode 100644 >>>> index 0000000000..212c69ce8b >>>> --- /dev/null >>>> +++ b/CONTRIBUTING.md >>>> @@ -0,0 +1,3 @@ >>>> +# Contributing to EDK2 >>>> + >>>> +Contributor documentation is maintained on the wiki: https://github.com/tianocore/tianocore.github.io/wiki/EDK-II-Development-Process >>>> >>> >>> Does github display "CONTRIBUTING.md" automatically? >>> >>> Hm... If I check , there's an explicit reference to "CONTRIBUTING.md" at the bottom of "README.md"; github.com seems to display "README.md" only. >>> >>> Is this patch useful without modifying "ReadMe.rst"? >>> >> >> When submitting a new pull request via the web UI, github will link to >> CONTRIBUTING.md for that repo if it exists. I just tried with >> virt-manager: for first time PRs it will give a pop up notification, but >> it also always shows a link in a small line underneath the initial PR >> comment box. Previously it was linked at the top IIRC. >> >> Some more info here: >> https://docs.github.com/en/github/building-a-strong-community/setting-guidelines-for-repository-contributors > > This has convinced me, thanks. I've tried the above myself, and it is > indeed as you explain (see the screenshot with highlights attached). And > both highlighted links refer to: > > https://github.com/virt-manager/virt-manager/blob/master/CONTRIBUTING.md > > > I suggest extending the commit message: > > """ > Add it to CONTRIBUTING.md for more discoverability. > > (When someone opens a pull request, they will see a link to > CONTRIBUTING.md; see > .) > """ > > But we can edit the commit message like this this without a resubmit. > ACK from me > >> >>> >>> ... Actually, the section at >>> >>> https://github.com/tianocore/edk2/#resources >>> >>> includes "How To Contribute" -> >>> >>> https://github.com/tianocore/tianocore.github.io/wiki/How-To-Contribute >>> >>> Is that unhelpful (or difficult to find)? >> >> I did not read the Readme TBH. I did grep sources for a link to that >> wiki page you linked me, and 'pull request' to see if I was missing doc >> links. >> >> Maybe CONTRIBUTING.md isn't the way to go. I mostly wanted to start a >> discussion about how to make it clear to drive-by contributors that PRs >> aren't meant for them. Changing the mergify message or pull request >> message template is more targeted. But they will probably want to link >> to a document that explains the PR workflow better, and that >> EDK-II-Development-Process is the closest I've seen so far > > I agree with both of your other suggestions (extending the mergify > message upon auto-close, and adding a PR template with some > explanation), but I'd also like us to apply this patch -- because github > does reference CONTRIBUTING.md automatically. > The one bit to consider is whether the link I specified makes sense, or if CONTRIBUTING.md should point to the link you suggested https://github.com/tianocore/tianocore.github.io/wiki/How-To-Contribute which seems like it is the intended entry point for contributor info. Thought that page should probably be updated to also point to https://github.com/tianocore/tianocore.github.io/wiki/EDK-II-Development-Process Thanks, Cole