From bcf5657e5c77225f5f1e1ed5672af7e669bd3477 Mon Sep 17 00:00:00 2001 From: "James R. Barlow" Date: Wed, 26 Aug 2020 17:11:52 -0700 Subject: [PATCH] Reorganize issue templates --- ...{general-issues.md => 1-general-issues.md} | 0 ...> 2-problem-with-a-specific-input-file.md} | 0 ...eature_request.md => 3-feature_request.md} | 0 .github/ISSUE_TEMPLATE/bug_report.md | 38 ------------------- .github/issue_template.md | 32 ---------------- .gitignore | 1 + 6 files changed, 1 insertion(+), 70 deletions(-) rename .github/ISSUE_TEMPLATE/{general-issues.md => 1-general-issues.md} (100%) rename .github/ISSUE_TEMPLATE/{problem-with-a-specific-input-file.md => 2-problem-with-a-specific-input-file.md} (100%) rename .github/ISSUE_TEMPLATE/{feature_request.md => 3-feature_request.md} (100%) delete mode 100644 .github/ISSUE_TEMPLATE/bug_report.md delete mode 100644 .github/issue_template.md diff --git a/.github/ISSUE_TEMPLATE/general-issues.md b/.github/ISSUE_TEMPLATE/1-general-issues.md similarity index 100% rename from .github/ISSUE_TEMPLATE/general-issues.md rename to .github/ISSUE_TEMPLATE/1-general-issues.md diff --git a/.github/ISSUE_TEMPLATE/problem-with-a-specific-input-file.md b/.github/ISSUE_TEMPLATE/2-problem-with-a-specific-input-file.md similarity index 100% rename from .github/ISSUE_TEMPLATE/problem-with-a-specific-input-file.md rename to .github/ISSUE_TEMPLATE/2-problem-with-a-specific-input-file.md diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/3-feature_request.md similarity index 100% rename from .github/ISSUE_TEMPLATE/feature_request.md rename to .github/ISSUE_TEMPLATE/3-feature_request.md diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md deleted file mode 100644 index dd84ea78..00000000 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ /dev/null @@ -1,38 +0,0 @@ ---- -name: Bug report -about: Create a report to help us improve -title: '' -labels: '' -assignees: '' - ---- - -**Describe the bug** -A clear and concise description of what the bug is. - -**To Reproduce** -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. - -**Screenshots** -If applicable, add screenshots to help explain your problem. - -**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.md b/.github/issue_template.md deleted file mode 100644 index 4aedbdf1..00000000 --- a/.github/issue_template.md +++ /dev/null @@ -1,32 +0,0 @@ -**Describe the issue** -A clear and concise description of what the issue is. - -**To Reproduce** -What command line were you trying to run? - -```bash -ocrmypdf ...arguments... input.pdf output.pdf -``` - -**Example file** -Please include an example *input* PDF (or image). You could also try to use of the files in ``tests/resources/`` to illustrate your issue. - -Please check any or all that apply about the example file: - -- [ ] This is the input file -- [ ] The file contains no personal or confidential information - -Please do *not* submit files with confidential information. At your option you may encrypt files for OCRmyPDF's author only. - -Issues submitted without an example input file are less likely to be resolved. The output file is generally not helpful. - -**Expected behavior** -A clear and concise description of what you expected to happen. Include screenshots if applicable. - -**System:** - -- OS: [e.g. Linux, macOS] -- OCRmyPDF Version: [e.g. v10.3.0] - -**Additional context** -Add any other context about the problem here. diff --git a/.gitignore b/.gitignore index 90884590..7fc65e63 100644 --- a/.gitignore +++ b/.gitignore @@ -7,6 +7,7 @@ !.gitignore !.pre-commit-config.yaml !.readthedocs.yml +!.github/ # Dev scratch *.ipynb