Merge pull request #2526 from pypa/more-diagnose-and-better-templates

More diagnose and better templates
This commit is contained in:
Tzu-ping Chung
2018-07-08 04:52:29 +08:00
committed by GitHub
5 changed files with 66 additions and 11 deletions
+6 -1
View File
@@ -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.
+13 -3
View File
@@ -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
+11 -3
View File
@@ -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
+25 -1
View File
@@ -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
+11 -3
View File
@@ -123,10 +123,18 @@ 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'
☤ An exception is raised during ``Locking dependencies…``
---------------------------------------------------------
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.