Skip to content

Commit

Permalink
Modernize issue templates
Browse files Browse the repository at this point in the history
  • Loading branch information
jbarlow83 committed Jun 2, 2023
1 parent 4769a6c commit 5a82ad6
Show file tree
Hide file tree
Showing 6 changed files with 77 additions and 100 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,6 @@ body:
label: What were you trying to do?
description: Also tell us, what did you expect to happen?
placeholder: Tell us what you see!
value: "A bug happened!"
validations:
required: true
- type: dropdown
Expand All @@ -30,6 +29,9 @@ body:
- Docker container
- Ubuntu snap
- Conda
- source build
validations:
required: true
- type: dropdown
id: operating-system
attributes:
Expand All @@ -45,6 +47,4 @@ body:
attributes:
label: Relevant log output
description: Please copy and paste any relevant log output. This will be automatically formatted into code, so no need for backticks.
render: shell


render: plain text
61 changes: 61 additions & 0 deletions .github/ISSUE_TEMPLATE/2-problem-with-specific-file.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,61 @@
name: Problem with specific file
description: Something went wrong while trying to OCR a specific file
title: "[Bug]: "
labels: ["bug", "triage"]
assignees:
- jbarlow83
body:
- type: markdown
attributes:
value: |
Thanks for taking the time to describe this issue with a particular file.
- type: textarea
id: what-happened
attributes:
label: Describe the bug
description: A clear and concise description of what the bug is.
placeholder: Tell us what you see!
validations:
required: true
- type: textarea
id: reproduce
attributes:
label: Steps to reproduce
description: Please include steps to reproduce
value: |
1. Run ocrmypdf -v1 ...arguments... input.pdf output.pdf
2. Open output.pdf
3. ...
render: plain text
- type: textarea
id: files
attributes:
label: Files
description: Please attach the input and output files, or any screenshots that may be helpful.
placeholder: Drag and drop files here
- type: dropdown
id: packaging-system
attributes:
label: How did you download and install the software?
multiple: true
options:
- PyPI (pip, poetry, pipx, etc.)
- Linux package manager (apt, dnf, etc.)
- Homebrew
- Docker container
- Ubuntu snap
- Conda
- source build
- type: input
id: version
attributes:
label: OCRmyPDF version
description: Paste "ocrmypdf --version" here
placeholder: ocrmypdf --version
- type: textarea
id: logs
attributes:
label: Relevant log output
description: Please copy and paste any relevant log output. This will be automatically formatted into code, so no need for backticks.
placeholder: Run OCRmyPDF with verbosity `-v1` to get more detailed logging output.
render: plain text
12 changes: 12 additions & 0 deletions .github/ISSUE_TEMPLATE/3-feature-request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
name: Feature request
description: Suggest an idea for this project
title: "[Feature]: "
labels: ["enhancement", "triage"]
assignees:
- jbarlow83
body:
- type: textarea
id: feature
attributes:
label: Describe the proposed feature
description: A clear and concise description of what the desired is.
23 changes: 0 additions & 23 deletions .github/ISSUE_TEMPLATE/feature_request.md

This file was deleted.

33 changes: 0 additions & 33 deletions .github/ISSUE_TEMPLATE/general-issues.md

This file was deleted.

40 changes: 0 additions & 40 deletions .github/ISSUE_TEMPLATE/problem-with-specific-file.md

This file was deleted.

0 comments on commit 5a82ad6

Please sign in to comment.