diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md index 10506bc0..b2326555 100644 --- a/.github/ISSUE_TEMPLATE.md +++ b/.github/ISSUE_TEMPLATE.md @@ -1,15 +1,11 @@ Be sure to check the existing issues (both open and closed!). -Describe the issue briefly here. - -Please run `$ python -m pipenv.help`, and paste the results here. - -If you're on MacOS, just run the following: - - $ python -m pipenv.help | pbcopy - ------------ +##### Issue description + +Describe the issue briefly here. + ##### Expected result Describe what you expected. @@ -21,3 +17,15 @@ When possible, provide the verbose output (`--verbose`), especially for locking ##### Steps to replicate 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. + +If you're on macOS, run the following: + + $ pipenv --support | pbcopy + +If you're on Windows, run the following: + + > pipenv --support | clip diff --git a/.github/ISSUE_TEMPLATE/Bug_report.md b/.github/ISSUE_TEMPLATE/Bug_report.md index 03aa41a1..c6b47876 100644 --- a/.github/ISSUE_TEMPLATE/Bug_report.md +++ b/.github/ISSUE_TEMPLATE/Bug_report.md @@ -1,29 +1,37 @@ ---- -name: Bug report -about: Create a report to help us improve - ---- - -Be sure to check the existing issues (both open and closed!). - -Describe the issue briefly here. - -Please run `$ python -m pipenv.help`, and paste the results here. - -If you're on MacOS, just run the following: - - $ python -m pipenv.help | pbcopy - ------------- - -##### Expected result - -Describe what you expected. - -##### Actual result - -When possible, provide the verbose output (`--verbose`), especially for locking and dependencies resolving issues. - -##### Steps to replicate - -Provide the steps to replicate (which usually at least includes the commands and the Pipfile). +--- +name: Bug report +about: Create a report to help us improve + +--- + +Be sure to check the existing issues (both open and closed!). + +------------ + +##### Issue description + +Describe the issue briefly here. + +##### Expected result + +Describe what you expected. + +##### Actual result + +When possible, provide the verbose output (`--verbose`), especially for locking and dependencies resolving issues. + +##### Steps to replicate + +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. + +If you're on macOS, run the following: + + $ pipenv --support | pbcopy + +If you're on Windows, run the following: + + > pipenv --support | clip diff --git a/.github/ISSUE_TEMPLATE/Custom.md b/.github/ISSUE_TEMPLATE/Custom.md index d31ed75e..5166a09e 100644 --- a/.github/ISSUE_TEMPLATE/Custom.md +++ b/.github/ISSUE_TEMPLATE/Custom.md @@ -1,7 +1,22 @@ ---- -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. +--- +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. + +If Pipenv is not functioning as you would like it to, consider filing either a bug report, or a feature request instead. + + +------------- + +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 diff --git a/.github/ISSUE_TEMPLATE/Feature_request.md b/.github/ISSUE_TEMPLATE/Feature_request.md index 53842951..4876c2a8 100644 --- a/.github/ISSUE_TEMPLATE/Feature_request.md +++ b/.github/ISSUE_TEMPLATE/Feature_request.md @@ -1,17 +1,23 @@ ---- -name: Feature request -about: Suggest an idea for this project - ---- - -**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 [...] - -**Describe the solution you'd like** -A clear and concise description of what you want to happen. - -**Describe alternatives you've considered** -A clear and concise description of any alternative solutions or features you've considered. - -**Additional context** -Add any other context or screenshots about the feature request here. +--- +name: Feature request +about: Suggest an idea for this project + +--- + +Be sure to check the existing issues (both open and closed!). + +##### 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 [...] + +##### Describe the solution you'd like + +A clear and concise description of what you want to happen. + +##### Describe alternatives you've considered + +A clear and concise description of any alternative solutions or features you've considered. + +##### 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.