GH issue template with cue to check NCBI server

This closes #84 and #85.
ropensci · Mar 12, 2017 · f815d02 · f815d02
1 parent dd2244d
commit f815d02
Show file tree

Hide file tree

Showing 2 changed files with 18 additions and 0 deletions.
diff --git a/CONTRIBUTING.md → .github/CONTRIBUTING.md b/CONTRIBUTING.md → .github/CONTRIBUTING.md
diff --git a/.github/issue_template.md b/.github/issue_template.md
@@ -0,0 +1,18 @@
+<!-- 
+
+Sometimes rentrez will throw obscure error messages because the NCBI's webservers
+are down or otherwise not behaving as they are meant to. Before reporting issues
+about errors thrown while contacting an NCBI database (search, fetch, summary,
+link...) you can test the NCBI is responding to requests by pasting the
+following URLS into a web browser.
+
+https://eutils.ncbi.nlm.nih.gov/entrez/eutils/efetch.fcgi?db=snp&id=6060535&retmote=rsr
+https://eutils.ncbi.nlm.nih.gov/entrez/eutils/esearch.fcgi?db=pubmed&term=rentrez
+
+They should give you a plain text file and a small XML file respectively. If you
+receive errors when trying to aces the URLs it is likely they the NCBI is
+having an intermittent problem, try your request again in a few minutes.
+
+If those pages load as expected then please file your issue. We appreciate user
+feedback and will do our best to help. 
+-->