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.web12.3483.1597186318002418348 for ; Tue, 11 Aug 2020 15:51:58 -0700 Authentication-Results: mx.groups.io; dkim=pass header.i=@redhat.com header.s=mimecast20190719 header.b=CLk07Nel; spf=pass (domain: redhat.com, ip: 205.139.110.61, mailfrom: crobinso@redhat.com) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1597186317; 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=DCKbDH87JewF10JH7mQRa7mr1h+h1IApU+GYz5j7/G0=; b=CLk07NelDKcbg1bku5QV8g/ke2SalUc3rMME3pg81lPScdGhmIICcVsnJf93YCYZF5wZMZ sm/mo7bN18JZkdwTdhWixlv2pI/ViMiSCgRxXA8R3yDyVIvoWB2JQsUCXC8yRuK3r6GgEc qzlk3l2hGWGns9JhAlLeNs25UUYfmk0= 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-388-MStAvhivNL2w_QCiJaNFxg-1; Tue, 11 Aug 2020 18:51:52 -0400 X-MC-Unique: MStAvhivNL2w_QCiJaNFxg-1 Received: from smtp.corp.redhat.com (int-mx04.intmail.prod.int.phx2.redhat.com [10.5.11.14]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by mimecast-mx01.redhat.com (Postfix) with ESMTPS id 6E4A680048F; Tue, 11 Aug 2020 22:51:51 +0000 (UTC) Received: from [10.10.118.49] (ovpn-118-49.rdu2.redhat.com [10.10.118.49]) by smtp.corp.redhat.com (Postfix) with ESMTP id EA2595D9D7; Tue, 11 Aug 2020 22:51:50 +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 References: <06fed550-e96a-4a12-7550-22156cb8a414@redhat.com> From: "Cole" Message-ID: Date: Tue, 11 Aug 2020 18:51:50 -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: <06fed550-e96a-4a12-7550-22156cb8a414@redhat.com> X-Scanned-By: MIMEDefang 2.79 on 10.5.11.14 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/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 > > ... 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 Thanks, Cole