diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md index e1530fcc..18e12434 100644 --- a/.github/ISSUE_TEMPLATE.md +++ b/.github/ISSUE_TEMPLATE.md @@ -1,27 +1,27 @@ Be sure to check the existing issues (both open and closed!), and make sure you are running the latest version of Pipenv. -If you're requesting a new feature or leaving feedback, please use this forum instead: +If you're requesting a new feature, please use the PEEP process: - https://kenneth-reitz.uservoice.com/forums/913660-general + https://github.com/pypa/pipenv/blob/master/peeps/PEEP-000.md 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 +### Issue description Describe the issue briefly here. -##### Expected result +### Expected result Describe what you expected. -##### Actual result +### Actual result When possible, provide the verbose output (`--verbose`), especially for locking and dependencies resolving issues. -##### Steps to replicate +### Steps to replicate Provide the steps to replicate (which usually at least includes the commands and the Pipfile). diff --git a/.github/ISSUE_TEMPLATE/Bug_report.md b/.github/ISSUE_TEMPLATE/Bug_report.md index 0a9b3421..c470a867 100644 --- a/.github/ISSUE_TEMPLATE/Bug_report.md +++ b/.github/ISSUE_TEMPLATE/Bug_report.md @@ -5,28 +5,24 @@ about: Create a report to help us improve Be sure to check the existing issues (both open and closed!), and make sure you are running the latest version of Pipenv. -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 +### Issue description Describe the issue briefly here. -##### Expected result +### Expected result Describe what you expected. -##### Actual result +### Actual result When possible, provide the verbose output (`--verbose`), especially for locking and dependencies resolving issues. -##### Steps to replicate +### Steps to replicate Provide the steps to replicate (which usually at least includes the commands and the Pipfile). diff --git a/.github/ISSUE_TEMPLATE/Custom.md b/.github/ISSUE_TEMPLATE/Custom.md index 407e90cc..33839850 100644 --- a/.github/ISSUE_TEMPLATE/Custom.md +++ b/.github/ISSUE_TEMPLATE/Custom.md @@ -5,10 +5,6 @@ about: Requests for assistance or general usage guidance. **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. diff --git a/.github/ISSUE_TEMPLATE/Feature_request.md b/.github/ISSUE_TEMPLATE/Feature_request.md index 4292912e..8a30d5aa 100644 --- a/.github/ISSUE_TEMPLATE/Feature_request.md +++ b/.github/ISSUE_TEMPLATE/Feature_request.md @@ -5,28 +5,23 @@ about: Suggest an idea for this project Be sure to check the existing issues (both open and closed!), and make sure you are running the latest version of Pipenv. -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. +Check the [diagnose documentation](https://docs.pipenv.org/diagnose/) for common issues and the [PEEP list](https://github.com/pypa/pipenv/blob/master/peeps/) before posting! We may close your issue if it is very similar to one of them. Please be considerate and follow the PEEP process, 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. +### 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 +### Describe the solution you'd like A clear and concise description of what you want to happen. -##### Describe alternatives you've considered +### Describe alternatives you've considered A clear and concise description of any alternative solutions or features you've considered. -##### Additional context +### 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. diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 9eb5f393..0e1c095b 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,25 +1,28 @@ Thank you for contributing to Pipenv! -##### The issue +### The issue What is the thing you want to fix? Is it associated with an issue on GitHub? Please mention it. Always consider opening an issue first to describe your problem, so we can discuss what is the best way to amend it. Note that if you do not describe the goal of this change or link to a related issue, the maintainers may close the PR without further review. +If your pull request makes a non-insignificant change to Pipenv, such as the user interface or intended functionality, please file a PEEP. -##### The fix + https://github.com/pypa/pipenv/blob/master/peeps/PEEP-000.md + +### The fix How does this pull request fix your problem? Did you consider any alternatives? Why is this the *best* solution, in your opinion? -##### The checklist +### The checklist * [ ] Associated issue * [ ] A news fragment in the `news/` directory to describe this fix with the extension `.bugfix`, `.feature`, `.behavior`, `.doc`. `.vendor`. or `.trivial` (this will appear in the release changelog). Use semantic line breaks and name the file after the issue number or the PR #.