From 200e6faf2cbfb9633820ba74b316ebd341122262 Mon Sep 17 00:00:00 2001 From: Tzu-ping Chung Date: Thu, 5 Jul 2018 19:43:04 +0800 Subject: [PATCH 1/2] More diagnose and better templates --- .github/ISSUE_TEMPLATE.md | 7 +++++- .github/ISSUE_TEMPLATE/Bug_report.md | 16 +++++++++++--- .github/ISSUE_TEMPLATE/Custom.md | 14 +++++++++--- .github/ISSUE_TEMPLATE/Feature_request.md | 26 ++++++++++++++++++++++- docs/diagnose.rst | 11 +++++++--- 5 files changed, 63 insertions(+), 11 deletions(-) diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md index c8387e5f..69e5dad2 100644 --- a/.github/ISSUE_TEMPLATE.md +++ b/.github/ISSUE_TEMPLATE.md @@ -4,6 +4,11 @@ If you're requesting a new feature or leaving feedback, please use this forum in https://kenneth-reitz.uservoice.com/forums/913660-general +Check the [diagnose documentation](https://docs.pipenv.org/diagnose/) for common issues before posting! We may close your issue if it is very similar to one of them. Please be considerate, or be on your way. + +Make sure to mention your debugging experience if the documented solution failed. + + ##### Issue description Describe the issue briefly here. @@ -20,7 +25,7 @@ When possible, provide the verbose output (`--verbose`), especially for locking Provide the steps to replicate (which usually at least includes the commands and the Pipfile). ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- +------------------------------------------------------------------------------- Please run `$ pipenv --support`, and paste the results here. Don't put backticks (`` ` ``) around it! The output already contains Markdown formatting. diff --git a/.github/ISSUE_TEMPLATE/Bug_report.md b/.github/ISSUE_TEMPLATE/Bug_report.md index c6b47876..229919b8 100644 --- a/.github/ISSUE_TEMPLATE/Bug_report.md +++ b/.github/ISSUE_TEMPLATE/Bug_report.md @@ -1,12 +1,18 @@ --- name: Bug report about: Create a report to help us improve - --- Be sure to check the existing issues (both open and closed!). ------------- +If you're requesting a new feature or leaving feedback, please use this forum instead: + + https://kenneth-reitz.uservoice.com/forums/913660-general + +Check the [diagnose documentation](https://docs.pipenv.org/diagnose/) for common issues before posting! We may close your issue if it is very similar to one of them. Please be considerate, or be on your way. + +Make sure to mention your debugging experience if the documented solution failed. + ##### Issue description @@ -24,7 +30,7 @@ When possible, provide the verbose output (`--verbose`), especially for locking Provide the steps to replicate (which usually at least includes the commands and the Pipfile). -------------- +------------------------------------------------------------------------------- Please run `$ pipenv --support`, and paste the results here. Don't put backticks (`` ` ``) around it! The output already contains Markdown formatting. @@ -35,3 +41,7 @@ If you're on macOS, run the following: If you're on Windows, run the following: > pipenv --support | clip + +If you're on Linux, run the following: + + $ pipenv --support | xclip diff --git a/.github/ISSUE_TEMPLATE/Custom.md b/.github/ISSUE_TEMPLATE/Custom.md index 5166a09e..407e90cc 100644 --- a/.github/ISSUE_TEMPLATE/Custom.md +++ b/.github/ISSUE_TEMPLATE/Custom.md @@ -1,15 +1,19 @@ --- name: Usage / Requests for Help about: Requests for assistance or general usage guidance. - --- -Please refer to our [StackOverflow tag](https://stackoverflow.com/questions/tagged/pipenv) for more information. +**AVOID POSTING ISSUES UNDER THIS CATEGORY.** + +If you're requesting a new feature or leaving feedback, please use this forum instead: + + https://kenneth-reitz.uservoice.com/forums/913660-general If Pipenv is not functioning as you would like it to, consider filing either a bug report, or a feature request instead. +Please refer to [StackOverflow tag](https://stackoverflow.com/questions/tagged/pipenv) for more information. -------------- +------------------------------------------------------------------------------- Please run `$ pipenv --support`, and paste the results here. Don't put backticks (`` ` ``) around it! The output already contains Markdown formatting. @@ -20,3 +24,7 @@ If you're on macOS, run the following: If you're on Windows, run the following: > pipenv --support | clip + +If you're on Linux, run the following: + + $ pipenv --support | xclip diff --git a/.github/ISSUE_TEMPLATE/Feature_request.md b/.github/ISSUE_TEMPLATE/Feature_request.md index 4876c2a8..5418f88e 100644 --- a/.github/ISSUE_TEMPLATE/Feature_request.md +++ b/.github/ISSUE_TEMPLATE/Feature_request.md @@ -1,11 +1,19 @@ --- name: Feature request about: Suggest an idea for this project - --- Be sure to check the existing issues (both open and closed!). +If you're requesting a new feature or leaving feedback, please use this forum instead: + + https://kenneth-reitz.uservoice.com/forums/913660-general + +Check the [diagnose documentation](https://docs.pipenv.org/diagnose/) for common issues before posting! We may close your issue if it is very similar to one of them. Please be considerate, or be on your way. + +Make sure to mention your debugging experience if the documented solution failed. + + ##### Is your feature request related to a problem? Please describe. A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] @@ -21,3 +29,19 @@ A clear and concise description of any alternative solutions or features you've ##### Additional context Add any other context or screenshots about the feature request here. It may be a good idea to mention that platform and Python version you are on. + +------------------------------------------------------------------------------- + +Please run `$ pipenv --support`, and paste the results here. Don't put backticks (`` ` ``) around it! The output already contains Markdown formatting. + +If you're on macOS, run the following: + + $ pipenv --support | pbcopy + +If you're on Windows, run the following: + + > pipenv --support | clip + +If you're on Linux, run the following: + + $ pipenv --support | xclip diff --git a/docs/diagnose.rst b/docs/diagnose.rst index 4802a2d7..9308d234 100644 --- a/docs/diagnose.rst +++ b/docs/diagnose.rst @@ -123,10 +123,15 @@ for more information. ☤ Using ``pipenv run`` in Supervisor program --------------------------------------------- -When you configure a supervisor program's ``command`` with ``pipenv run ...``, you -need to set locale enviroment variables properly to make it work. +When you configure a supervisor program's ``command`` with ``pipenv run ...``, you +need to set locale enviroment variables properly to make it work. Add this line under ``[supervisord]`` section in ``/etc/supervisor/supervisord.conf``:: - + [supervisord] environment=LC_ALL='en_US.UTF-8',LANG='en_US.UTF-8' + +☤ Exception “InvalidMarker: Invalid marker: '…'” raised during locking +---------------------------------------------------------------------- + +Run ``pipenv lock --clear`` and try again. From 4edcf58ec45252397f207faeacb12a016d112272 Mon Sep 17 00:00:00 2001 From: Tzu-ping Chung Date: Thu, 5 Jul 2018 19:49:41 +0800 Subject: [PATCH 2/2] Elaborate what --clear does --- docs/diagnose.rst | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) diff --git a/docs/diagnose.rst b/docs/diagnose.rst index 9308d234..88407099 100644 --- a/docs/diagnose.rst +++ b/docs/diagnose.rst @@ -131,7 +131,10 @@ Add this line under ``[supervisord]`` section in ``/etc/supervisor/supervisord.c [supervisord] environment=LC_ALL='en_US.UTF-8',LANG='en_US.UTF-8' -☤ Exception “InvalidMarker: Invalid marker: '…'” raised during locking ----------------------------------------------------------------------- +☤ An exception is raised during ``Locking dependencies…`` +--------------------------------------------------------- -Run ``pipenv lock --clear`` and try again. +Run ``pipenv lock --clear`` and try again. The lock sequence caches results +to speed up subsequent runs. The cache may contain faulty results if a bug +causes the format to corrupt, even after the bug is fixed. ``--clear`` flushes +the cache, and therefore removes the bad results.