Add description how to create issues and issue template

Signed-off-by: Igor Shishkin <[email protected]>
teran · Oct 20, 2017 · b2fd44b · b2fd44b
1 parent e6084d8
commit b2fd44b
Show file tree

Hide file tree

Showing 2 changed files with 31 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -53,3 +53,11 @@ Image format supported and tested:
 * Nikon RAW(`*.nef` - only, `*.nrw` is not supported yet)
 * TIFF
 * Sony RAW(`*.arw`, `*.sr2`) - Experimental at the moment
+
+# Contributing
+
+Feel free to create a pull request via GitHub interface ;)
+
+# Bugs reporting
+
+Please feel free to create a [GitHub issue](https://github.com/teran/deduplicator/issues/new)
diff --git a/docs/issue_template.md b/docs/issue_template.md
@@ -0,0 +1,23 @@
+### What you've done step-by-step
+
+
+### What you've expected to get as a result
+
+
+### What you've got in fact
+
+
+### Additional data
+Please don't forget to attach `Deduplicator.log` file present in your Documents folder(present since 1.0.0.100007).
+Please note: `Deduplicator.log` could contain some information related to your system including but not limited to:
+
+ * OS version
+ * OS architecture
+ * CPU cores amount
+ * RAM size
+ * Display details such as resolution
+ * Filesystem paths to images processed by Deduplicator
+
+You could always check `Deduplicator.log` file and mask all the data you think is sensible or private.
+
+**Please check `Deduplicator.log` each time you're creating an issue!**