From mboxrd@z Thu Jan 1 00:00:00 1970 Received: from us-smtp-delivery-1.mimecast.com (us-smtp-delivery-1.mimecast.com [205.139.110.61]) by mx.groups.io with SMTP id smtpd.web11.20156.1597253622573501699 for ; Wed, 12 Aug 2020 10:33:42 -0700 Authentication-Results: mx.groups.io; dkim=pass header.i=@redhat.com header.s=mimecast20190719 header.b=QMUPCerU; spf=pass (domain: redhat.com, ip: 205.139.110.61, mailfrom: lersek@redhat.com) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1597253621; 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=VqKQxE8omiOzuDiHgKzRVncTYKrOqin3NNTpu8q0tAU=; b=QMUPCerUazXdAHvT1Rjks6opG5JNoi96uj8vWPWHLjszmfWFGikAV5xVfgZBSzvN2IUgrL mJFz4cRi3enWddCTuOeD1fjYuCpY0kRlbz074Spa69LU9N+CM1PWNeVX+SZ5u7OVquNbXj a4bjfa0UcX0VzVScfKgTCgfDncQ2Pes= 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-182-G2X9KpZINLeGmQWpajHvwg-1; Wed, 12 Aug 2020 13:33:33 -0400 X-MC-Unique: G2X9KpZINLeGmQWpajHvwg-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 C5772800D55; Wed, 12 Aug 2020 17:33:32 +0000 (UTC) Received: from lacos-laptop-7.usersys.redhat.com (ovpn-114-34.ams2.redhat.com [10.36.114.34]) by smtp.corp.redhat.com (Postfix) with ESMTP id 61BE660C2A; Wed, 12 Aug 2020 17:33:31 +0000 (UTC) Subject: Re: [PATCH] Add a stub CONTRIBUTING.md pointing to the wiki To: Cole Robinson , 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> <9d611414-3a9a-2c4c-2b9f-56b72e2cc250@redhat.com> From: "Laszlo Ersek" Message-ID: <22126857-db76-7e92-2926-0c19f5985782@redhat.com> Date: Wed, 12 Aug 2020 19:33:30 +0200 User-Agent: Mozilla/5.0 (X11; Linux x86_64; rv:52.0) Gecko/20100101 Firefox/52.0 Thunderbird/52.9.1 MIME-Version: 1.0 In-Reply-To: <9d611414-3a9a-2c4c-2b9f-56b72e2cc250@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=lersek@redhat.com X-Mimecast-Spam-Score: 0 X-Mimecast-Originator: redhat.com Content-Language: en-US Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: 7bit On 08/12/20 18:00, Cole Robinson wrote: > 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 One issue with documentation is that the more you add of it, the more it constantly needs to be reorganized / refactored. All wikis always exist at a level of both redundancy and blank spots. I think the link in your patch is good. Thanks Laszlo