diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index daf2e24d..dd84ea78 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -11,22 +11,11 @@ assignees: '' A clear and concise description of what the bug is. **To Reproduce** -What command line or API call were you trying to run? - -```bash -ocrmypdf ...arguments... input.pdf output.pdf -``` - -Run with verbosity or higher `-v1` to see more detailed logging. This information may be helpful. - -**Example file** -Include an input PDF or image that demonstrates your issue. - -Please provide an input file with no personal or confidential information. At your option you may `GPG-encrypt the file ` for OCRmyPDF's author only. - -Links to files hosted elsewhere are perfectly acceptable. You could also look in ``tests/resources`` and see if any of those files reproduce your issue. - -(Exceptions: Issues with installation, command line argument parsing, test suite failures.Issues without example files usually cannot be resolved.) +Steps to reproduce the behavior: +1. Go to '...' +2. Click on '....' +3. Scroll down to '....' +4. See error **Expected behavior** A clear and concise description of what you expected to happen. @@ -34,7 +23,16 @@ A clear and concise description of what you expected to happen. **Screenshots** If applicable, add screenshots to help explain your problem. -**System** - - OS: [e.g. Linux, Windows, macOS] - - OCRmyPDF Version: ``ocrmypdf --version`` - - How did you install ocrmypdf? Did you use a system package manager, `pip`, or a Docker image? +**Desktop (please complete the following information):** + - OS: [e.g. iOS] + - Browser [e.g. chrome, safari] + - Version [e.g. 22] + +**Smartphone (please complete the following information):** + - Device: [e.g. iPhone6] + - OS: [e.g. iOS8.1] + - Browser [e.g. stock browser, safari] + - Version [e.g. 22] + +**Additional context** +Add any other context about the problem here. diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md index 59094e26..bbcbbe7d 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -2,7 +2,7 @@ name: Feature request about: Suggest an idea for this project title: '' -labels: enhancement +labels: '' assignees: '' --- @@ -13,5 +13,8 @@ A clear and concise description of what the problem is. Ex. I'm always frustrate **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. diff --git a/.github/ISSUE_TEMPLATE/general-issues.md b/.github/ISSUE_TEMPLATE/general-issues.md new file mode 100644 index 00000000..1e58db9e --- /dev/null +++ b/.github/ISSUE_TEMPLATE/general-issues.md @@ -0,0 +1,28 @@ +--- +name: General issues +about: Installation, packages, dependencies, "nothing works", test suite failures... +title: '' +labels: '' +assignees: '' + +--- + +**Describe the bug** +What's the problem? + +**To Reproduce** +Steps to reproduce the behavior. + +**Expected behavior** +What did you expected to happen? + +**Screenshots** +If applicable, add screenshots to help explain your problem. + +**System (please complete the following information):** + - OS: + - Python version: + - OCRmyPDF version: + +**Additional context** +Add any other context about the problem here. diff --git a/.github/ISSUE_TEMPLATE/problem-with-a-specific-input-file.md b/.github/ISSUE_TEMPLATE/problem-with-a-specific-input-file.md new file mode 100644 index 00000000..595d9cee --- /dev/null +++ b/.github/ISSUE_TEMPLATE/problem-with-a-specific-input-file.md @@ -0,0 +1,40 @@ +--- +name: Problem with a specific input file +about: Something went wrong while trying to OCR a specific file +title: '' +labels: '' +assignees: '' + +--- + +**Describe the bug** +A clear and concise description of what the bug is. + +**To Reproduce** +What command line or API call were you trying to run? + +```bash +ocrmypdf ...arguments... input.pdf output.pdf +``` + +Run with verbosity or higher `-v1` to see more detailed logging. This information may be helpful. + +**Example file** +If your issue is a problem that affects only certain files, and we will require an input file (PDF or image) that demonstrates your issue. + +Please provide an input file with no personal or confidential information. At your option you may [GPG-encrypt the file](https://github.com/jbarlow83/OCRmyPDF/wiki) for OCRmyPDF's author only. + +Links to files hosted elsewhere are perfectly acceptable. You could also look in ``tests/resources`` and see if any of those files reproduce your issue. + +*(Issues without example files usually cannot be resolved. It's like reporting an issue against a web browser without providing a URL.)* + +**Expected behavior** +A clear and concise description of what you expected to happen. + +**Screenshots** +If applicable, add screenshots to help explain your problem. + +**System** + - OS: [e.g. Linux, Windows, macOS] + - OCRmyPDF Version: ``ocrmypdf --version`` + - How did you install ocrmypdf? Did you use a system package manager, `pip`, or a Docker image?