Add menu item for reporting issue

brookhong · Jan 6, 2018 · ec9f4ea · ec9f4ea
1 parent 08ea590
commit ec9f4ea
Show file tree

Hide file tree

Showing 4 changed files with 36 additions and 8 deletions.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -0,0 +1,29 @@
+Thank you for willing to contribute on this project.
+
+## Reporting issues
+
+Please use below template to report issue, or you could click menu item from SurfingKeys icon in browser's tool bar.
+
+    ## Error details
+
+
+
+    SurfingKeys: 0.9.22
+
+    Browser: Mozilla/5.0 (Macintosh; Intel Mac OS X 10.12; rv:57.0) Gecko/20100101 Firefox/57.0
+
+    URL: <The_URL_Where_You_Find_The_Issue>
+
+    ## Context
+
+    **Please replace this with a description of how you were using SurfingKeys.**
+
+## Build
+
+    npm install
+    npm run build
+
+    npm run build firefox       # build webextension for firefox
+
+    npm run dev                 # build development version
+    npm run dev firefox         # build development version for firefox
diff --git a/README.md b/README.md
@@ -40,7 +40,6 @@ Surfingkeys works for Firefox(above 57) since 0.9.15, with below features as exc
 * [Mermaid diagram generator](#mermaid-diagram-generator)
 * [PDF viewer](#pdf-viewer)
 * [Edit your own settings](#edit-your-own-settings)
-* [Build](#build)
 * [License](#license)
 
 ## Feature list
@@ -657,13 +656,6 @@ For example,
         }
     }`;
 
-## Build
-
-    npm install
-    npm run build
-
-    npm run build firefox # build webextension for firefox
-
 ## API Documentation
 
 > The API documentation is currently a work in progress.

diff --git a/pages/popup.html b/pages/popup.html
@@ -23,6 +23,7 @@
         <a href="/pages/options.html" target="_blank">Settings</a>
         <a href="/pages/start.html" target="_blank">Help</a>
         <a href="/pages/markdown.html?r=/pages/changelog.md" target="_blank">Changelog</a>
+        <a id="reportIssue" href="#">Report issue</a>
         <hr/>
         <a href="/pages/pdf_viewer.html" target="_blank">PDF Viewer</a>
         <a href="/pages/markdown.html" target="_blank">Markdown preview</a>

diff --git a/pages/popup.js b/pages/popup.js
@@ -25,3 +25,9 @@ disableAll.addEventListener('click', function() {
         updateStatus(response.blacklist);
     });
 });
+
+document.getElementById('reportIssue').addEventListener('click', function () {
+    window.close();
+    var description = "%23%23+Error+details%0A%0A{0}%0A%0ASurfingKeys%3A+{1}%0A%0ABrowser%3A+{2}%0A%0AURL%3A+{3}%0A%0A%23%23+Context%0A%0A%2A%2APlease+replace+this+with+a+description+of+how+you+were+using+SurfingKeys.%2A%2A".format(encodeURIComponent(""), chrome.runtime.getManifest().version, encodeURIComponent(navigator.userAgent), encodeURIComponent("<The_URL_Where_You_Find_The_Issue>"));
+    window.open("https://github.com/brookhong/Surfingkeys/issues/new?title={0}&body={1}".format(encodeURIComponent(""), description));
+});