public inbox for devel@edk2.groups.io
 help / color / mirror / Atom feed
From: "Cole" <crobinso@redhat.com>
To: devel@edk2.groups.io
Cc: michael.d.kinney@intel.com, lersek@redhat.com,
	Cole Robinson <crobinso@redhat.com>
Subject: [PATCH] Add a stub CONTRIBUTING.md pointing to the wiki
Date: Tue, 11 Aug 2020 14:09:53 -0400	[thread overview]
Message-ID: <df6219e77613e93c494996437cf53e302c473392.1597168987.git.crobinso@redhat.com> (raw)

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 <crobinso@redhat.com>
---
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
-- 
2.26.2


             reply	other threads:[~2020-08-11 18:10 UTC|newest]

Thread overview: 7+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2020-08-11 18:09 Cole [this message]
2020-08-11 21:55 ` [PATCH] Add a stub CONTRIBUTING.md pointing to the wiki Laszlo Ersek
2020-08-11 22:51   ` Cole
2020-08-12  9:37     ` Laszlo Ersek
2020-08-12 16:00       ` Cole
2020-08-12 17:33         ` Laszlo Ersek
2020-08-18 18:17       ` [edk2-devel] " Laszlo Ersek

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-list from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=df6219e77613e93c494996437cf53e302c473392.1597168987.git.crobinso@redhat.com \
    --to=devel@edk2.groups.io \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox