From 88abe122cfca8779bd90c1d59c2c43057042dc78 Mon Sep 17 00:00:00 2001
From: Tom Limoncelli <tlimoncelli@stackexchange.com>
Date: Tue, 28 Jan 2020 14:36:28 -0500
Subject: [PATCH] Docs: Clarify bug triage process (#606)

---
 docs/bug-triage.md        | 60 +++++++++++++++++++++++++++++++++++++++
 docs/index.md             |  3 ++
 docs/writing-providers.md |  1 +
 3 files changed, 64 insertions(+)
 create mode 100644 docs/bug-triage.md

diff --git a/docs/bug-triage.md b/docs/bug-triage.md
new file mode 100644
index 000000000..9f0b4a205
--- /dev/null
+++ b/docs/bug-triage.md
@@ -0,0 +1,60 @@
+---
+layout: default
+title: Bug Triage Process
+---
+
+# Who to assign bugs to?
+
+If an issue is related to a particular provider, assign it to
+the person responsible for the provider, as listed in
+[Providers]({{site.github.url}}/provider-list)'s "Maintainers of
+contributed providers".
+
+Otherwise leave it unassigned until someone grabs it.
+
+
+# How bugs are classified
+
+labels:
+
+* enhancement: New feature of improvement of existing feature
+* bug: feature works wrong or not as expected
+
+priority:
+
+* maybe someday: Low priority
+
+# How to handle a provider request
+
+
+1. Change the subject to be "Provider request: name of the provider"
+1. Set the label `provider-request`
+1. Respond to the issue with the message below
+1. Close the issue
+
+The [Providers]({{site.github.url}}/provider-list) page is generated
+automatically from all the issues tagged `provider-request`:
+
+1. "Requested providers: state=closed, tagged `provider-request`
+1. "In progress providers": state=open, tagged `provider-request`, NOT tagged `has-pr`
+1. "Providers with open PRs": state=open, tagged `provider-request` AND `has-pr`
+
+Message to requester:
+
+```
+Thank you for requesting this provider!
+
+I've tagged this issue as a provider-request.  It will (soon) be listed as a "requested provider" on the provider list web page:
+https://stackexchange.github.io/dnscontrol/provider-list
+
+I will now close the issue.  I know that's a bit confusing, but it will remain on the "requested provider" list.
+
+If someone would like to volunteer to implement this, please re-open this issue and add the tag `has-pr`.
+
+We encourage you to try adding this provider yourself.  We've tried to
+make the process as friendly as possible.  Many people have reported
+that adding a provider was their first experience writing Go.  The
+process is documented here:
+https://stackexchange.github.io/dnscontrol/writing-providers
+If you need assistance, please speak up in this issue and someone will get back to you ASAP.
+```
diff --git a/docs/index.md b/docs/index.md
index 4e66552ce..74112c092 100644
--- a/docs/index.md
+++ b/docs/index.md
@@ -166,6 +166,9 @@ title: DNSControl
 				<li>
 					<a href="{{site.github.url}}/release-engineering">Release Engineering</a>: How to build and ship a release
 				</li>
+				<li>
+					<a href="{{site.github.url}}/bug-triage">Bug Triage</a>: How bugs are triaged
+				</li>
 			</ul>
 		</div>
 	</div>
diff --git a/docs/writing-providers.md b/docs/writing-providers.md
index cb3f43168..fddb7052a 100644
--- a/docs/writing-providers.md
+++ b/docs/writing-providers.md
@@ -177,6 +177,7 @@ go test -v -verbose -provider ROUTE53
 
 * Edit [README.md](https://github.com/StackExchange/dnscontrol): Add the provider to the bullet list.
 * Edit [docs/provider-list.md](https://github.com/StackExchange/dnscontrol/blob/master/docs/provider-list.md): Add the provider to the provider list.
+* FYI: The list of "Requested Providers" is generated dynamically from Github issues tagged `provider-request`.  When you close the issue related to your provider, the list will update automatically.
 * Create `docs/_providers/PROVIDERNAME.md`: Use one of the other files in that directory as a base.
 * Edit [OWNERS](https://github.com/StackExchange/dnscontrol/blob/master/OWNERS): Add the directory name and your github id.