From f953bc4af41852f804111beb7c1ccedcce1628f8 Mon Sep 17 00:00:00 2001 From: Andrew Senetar Date: Wed, 10 Oct 2018 21:12:01 -0500 Subject: [PATCH] Update README.md and ISSUE_TEMPLATE.md - Update ISSUE_TEMPLATE.md to help obtain better information for bug reports. - Update README.md to reflect more recent changes and highlight areas of need. --- .github/ISSUE_TEMPLATE.md | 26 +++++++++++++++++++++++--- README.md | 26 ++++++++++++-------------- 2 files changed, 35 insertions(+), 17 deletions(-) diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md index 27862300..8c32c12e 100644 --- a/.github/ISSUE_TEMPLATE.md +++ b/.github/ISSUE_TEMPLATE.md @@ -1,4 +1,24 @@ -Please note that dupeGuru is currently -[unmaintained](https://github.com/hsoft/dupeguru#current-status-unmaintained). That means that this -issue is unlikely to be answered in a timely manner. +# Instructions +1. Provide a short descriptive title for the issue. A good example is 'Results window appears off screen.', a non-optimal example is 'Problem with App'. +2. Please fill out either the 'Bug / Issue' or the 'Feature Request' section. Replace values in ` `. +3. Delete these instructions and the unused sections. +# Bug / issue Report +System Information: + - DupeGuru Version: `version` + - Operating System: `Windows/Linux/OSX` `distribution` `version` + +If using the source distribution and building yourself also provide (otherwise remove): + - Python Version: `version ex. 3.6.6` `32/64bit` + - Complier: `gcc/llvm/msvc` `version` + +## Description +`Provide a detailed description of the issue to help reproduce it. If it happens after a specific sequence of events provide them here.` + +## Debug Log +``` +If reporting an error provide the debug log and/or the error message information. If the debug log is short < 40 lines you can provide it here, otherwise attach the text file to this issue. +``` + +# Feature Requests +`Provide a detailed description of the feature.` diff --git a/README.md b/README.md index be04a204..814838df 100644 --- a/README.md +++ b/README.md @@ -7,23 +7,21 @@ is written in Objective-C and uses Cocoa. On Linux, it's written in Python and u The Cocoa UI of dupeGuru is hosted in a separate repo: https://github.com/hsoft/dupeguru-cocoa -## Current status: Unmaintained +## Current status: Additional Maintainers Wanted (/ Note on Things in General) -I haven't worked on dupeGuru for a while and frankly, I don't want to. I never had any duplicate -problems so I don't even care about the *raison d'être* of this thing. +When I started contributing to dupeGuru, it was to help provide an updated Windows build for dupeGuru. I hoped to contribute more over time and help work through some of the general issues as well. Since Virgil Dupras left as the lead maintainer, I have not been able to devote enough time to work through as many issues as I had hoped. Now I am going to be devoting a more consistent amount of time each month to work on dupeGuru, however I will not be able to get to all issues. Additionally there are a few specific areas where additional help would be appreciated: -I don't want to answer incoming issues and I don't want to let them pile off unanswered either, -that feels rude. So here I am, being straightforward about it. +- OSX maintenance + - UI issues (I have no experience with cocoa) + - General issues & releases (I lack OSX environments / hardware to develop and test on, looking into doing builds through Travis CI.) +- Linux maintenance + - Packaging (I have not really done much linux packaging yet, although will be spending some time trying to get at least .deb and potentially ppa's updated.) -If you're considering using dupeGuru, you might want to give it a try but if it doesn't meet your -needs I suggest that you use another program because it's unlikely to ever be improved again. +I am still working to update the new site & update links within the help and the repository to use the new urls. Additionally, hoping to get a 4.0.4 release out this year for at least Windows and Linux. -If you're a developer wanting to pick it up, by all means, do so! Fork it off and release -something. I will be more than happy to "officially" point to any fork that remotely looks like a -serious effort. I will also be happy to assist if you have questions about the code. +Thanks, -Good bye dupeGuru, -Virgil Dupras +Andrew Senetar ## Contents of this folder @@ -76,9 +74,9 @@ You can also run automated tests without Tox. Extra requirements for running tes `requirements-extra.txt`. So, you can do `pip install -r requirements-extra.txt` inside your virtualenv and then `py.test core hscommon` -[dupeguru]: https://www.hardcoded.net/dupeguru/ +[dupeguru]: https://dupeguru.voltaicideas.net/ [cross-toolkit]: http://www.hardcoded.net/articles/cross-toolkit-software -[documentation]: http://www.hardcoded.net/dupeguru/help/en/ +[documentation]: http://dupeguru.voltaicideas.net/help/en/ [python]: http://www.python.org/ [pyqt]: http://www.riverbankcomputing.com [tox]: https://tox.readthedocs.org/en/latest/