From b2fd44b6141369dbf2d97d27d56dd0e9ddc0f915 Mon Sep 17 00:00:00 2001 From: Igor Shishkin Date: Fri, 20 Oct 2017 21:22:34 +0300 Subject: [PATCH] Add description how to create issues and issue template Signed-off-by: Igor Shishkin --- README.md | 8 ++++++++ docs/issue_template.md | 23 +++++++++++++++++++++++ 2 files changed, 31 insertions(+) create mode 100644 docs/issue_template.md diff --git a/README.md b/README.md index fcc9366..4a09126 100644 --- 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 new file mode 100644 index 0000000..6b63e05 --- /dev/null +++ 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!**