From 7fe72cf708e4e15e3a438660d70f3a7495db44ba Mon Sep 17 00:00:00 2001 From: JustAnotherArchivist Date: Mon, 1 Jul 2019 16:01:11 +0000 Subject: [PATCH] Add a note about reporting issues with proper debugging information --- README.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/README.md b/README.md index 3e2d006..615fd9b 100644 --- a/README.md +++ b/README.md @@ -39,6 +39,9 @@ To get the latest 100 tweets with the hashtag #archiveteam: It is also possible to use snscrape as a library in Python, but this is currently undocumented. +## Issue reporting +If you discover an issue with snscrape, please report it at . If possible please run snscrape with `-vv` and `--dump-locals` and include the log output as well as the dump files referenced in the log in the issue. Note that the files may contain sensitive information in some cases and could potentially be used to identify you (e.g. if the service includes your IP address in its response). If you prefer to arrange a file transfer privately, just mention that in the issue. + ## License This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.