From c4156d6e787a0b920ed74aea1e4efade27b2889a Mon Sep 17 00:00:00 2001 From: Jeremy Singer-Vine Date: Thu, 30 Jul 2020 09:31:30 -0400 Subject: [PATCH] Add GitHub issue templates --- .github/ISSUE_TEMPLATE/bug-report.md | 50 ++++++++++++++++++++++ .github/ISSUE_TEMPLATE/feature-request.md | 9 ++++ .github/ISSUE_TEMPLATE/troubleshooting.md | 51 +++++++++++++++++++++++ 3 files changed, 110 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug-report.md create mode 100644 .github/ISSUE_TEMPLATE/feature-request.md create mode 100644 .github/ISSUE_TEMPLATE/troubleshooting.md diff --git a/.github/ISSUE_TEMPLATE/bug-report.md b/.github/ISSUE_TEMPLATE/bug-report.md new file mode 100644 index 0000000..13d2d2b --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug-report.md @@ -0,0 +1,50 @@ +--- +name: Bug report +about: Use this if you observe a specific problem with pdfplumber's code or results +title: '' +labels: bug +assignees: '' +--- + +## Describe the bug + +*A clear and concise description of what the bug is.* + + +## Code to reproduce the problem + +*Paste it here, or attach a Python file.* + + +## PDF file + +*Please attach any PDFs necessary to reproduce the problem.* + +*If you need to redact text in a sensitive PDF, you can run it through [JoshData/pdf-redactor](https://github.com/JoshData/pdf-redactor).* + + +## Expected behavior + +*What did you expect the result __should__ have been?* + + +## Actual behavior + +*What actually happened, instead?* + + +## Screenshots + +*If applicable, add screenshots to help explain your problem.* + + +## Environment + +- pdfplumber version: [e.g., 0.5.22] +- Python version: [e.g., 3.8.1] +- OS: [e.g., Mac, Linux, etc.] + + +## Additional context + +*Add any other context/notes about the problem here.* diff --git a/.github/ISSUE_TEMPLATE/feature-request.md b/.github/ISSUE_TEMPLATE/feature-request.md new file mode 100644 index 0000000..b8dc6ac --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature-request.md @@ -0,0 +1,9 @@ +--- +name: Feature request +about: Suggest a feature or improvement +title: '' +labels: feature-request +assignees: '' +--- + +Please describe, in as much detail as possible, your proposal and how it would improve your experience with pdfplumber. diff --git a/.github/ISSUE_TEMPLATE/troubleshooting.md b/.github/ISSUE_TEMPLATE/troubleshooting.md new file mode 100644 index 0000000..05c967d --- /dev/null +++ b/.github/ISSUE_TEMPLATE/troubleshooting.md @@ -0,0 +1,51 @@ +--- +name: Troubleshooting +about: Ask for assistance in using pdfplumber +title: '' +labels: troubleshooting +assignees: '' +--- + +## What are you trying to do? + +*A clear and concise description of your goals.* + + +## What code are you using to do it? + +*Paste it here, or attach a Python file.* + + +## PDF file + +*Please attach the PDFs used in the code.* + +*If you need to redact text in a sensitive PDF, you can run it through [JoshData/pdf-redactor](https://github.com/JoshData/pdf-redactor).* + + +## Expected behavior + +*What did you expect the result __should__ have been?* + + +## Actual behavior + +*What actually happened, instead?* + + +## Screenshots + +*If applicable, add screenshots to help explain your problem.* + + +## Environment + +- pdfplumber version: [e.g., 0.5.22] +- Python version: [e.g., 3.8.1] +- OS: [e.g., Mac, Linux, etc.] + + +## Additional context + +*Add any other context/notes about the problem here.* +