Skip to content

Commit

Permalink
Update issue templates
Browse files Browse the repository at this point in the history
  • Loading branch information
jbarlow83 committed Dec 15, 2022
1 parent 9e7b9de commit a0224d9
Show file tree
Hide file tree
Showing 3 changed files with 96 additions and 0 deletions.
23 changes: 23 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
---
name: Feature request
about: Suggest an idea for this project
title: ''
labels: ''
assignees: ''

---

**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. Please include the versions of OCRmyPDF and other supporting programs (Tesseract OCR, Ghostscript) - maybe an alternative already exists in a newer version.

**Example file**
If your issue concerns how OCRmyPDF processes certain files, and please provide an example file that helps illustrate how OCRmyPDF's output could be improve. You could also look in ``tests/resources`` and see if any of those files demonstrates your issue.

**Additional context**
Add any other context or screenshots about the feature request here.
33 changes: 33 additions & 0 deletions .github/ISSUE_TEMPLATE/general-issues.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
---
name: General issues
about: Installation, packages, dependencies, "nothing works", test suite failures...
title: "[BUG]"
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:
- Platform: x64 or ARM

**Installation**
How did you install OCRmyPDF? Did you install it from your operating system's
package manager, or using pip?

**Additional context**
Add any other context about the problem here.
40 changes: 40 additions & 0 deletions .github/ISSUE_TEMPLATE/problem-with-specific-file.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
---
name: Problem with specific file
about: Something went wrong while trying to OCR a specific file
title: "[BUG]"
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/ocrmypdf/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?

0 comments on commit a0224d9

Please sign in to comment.