2573dba8ed
Converted GitHub issue templates from Markdown to YAML Issue Forms with required field enforcement. Added documentation template. Updated PR template with local validation checkbox. Changes: - Added config.yml to disable blank issues and route to Discussions/Security - Converted bug_report, feature_request, performance_regression to .yml forms - Added documentation.yml template for docs issues - Updated security.yml as reference redirect to SECURITY.md - Updated PULL_REQUEST_TEMPLATE.md with local validation checkbox - Bug template enforces pdftract doctor output as required field Closes: pdftract-f29c Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
123 lines
3.5 KiB
YAML
123 lines
3.5 KiB
YAML
name: Bug report
|
|
description: Report a problem with pdftract
|
|
title: '[BUG] '
|
|
labels: [bug]
|
|
body:
|
|
- type: markdown
|
|
attributes:
|
|
value: |
|
|
Thanks for filing a bug report! Before you continue, please make sure you've searched for existing issues to avoid duplicates.
|
|
|
|
- type: textarea
|
|
id: bug_description
|
|
attributes:
|
|
label: Bug description
|
|
description: A clear and concise description of what the bug is.
|
|
placeholder: When I run pdftract on file X, I expect Y but get Z...
|
|
validations:
|
|
required: true
|
|
|
|
- type: textarea
|
|
id: reproduction_steps
|
|
attributes:
|
|
label: Steps to reproduce
|
|
description: Please provide detailed steps to reproduce the issue.
|
|
placeholder: |
|
|
1. Clone or download this PDF: ...
|
|
2. Run this command: `pdftract ...`
|
|
3. Observe this error: ...
|
|
render: shell
|
|
validations:
|
|
required: true
|
|
|
|
- type: textarea
|
|
id: pdftract_doctor
|
|
attributes:
|
|
label: `pdftract doctor` output
|
|
description: "**REQUIRED:** Run `pdftract doctor` and paste the output here. Without this information, we cannot effectively diagnose environment-related issues."
|
|
placeholder: Paste the full output of `pdftract doctor` here...
|
|
render: text
|
|
validations:
|
|
required: true
|
|
|
|
- type: textarea
|
|
id: expected_behavior
|
|
attributes:
|
|
label: Expected behavior
|
|
description: What should have happened?
|
|
placeholder: pdftract should have extracted the text correctly...
|
|
validations:
|
|
required: true
|
|
|
|
- type: textarea
|
|
id: actual_behavior
|
|
attributes:
|
|
label: Actual behavior
|
|
description: What actually happened? Include error messages, stack traces, or incorrect output.
|
|
placeholder: pdftract crashed with error E...
|
|
validations:
|
|
required: true
|
|
|
|
- type: input
|
|
id: pdf_version
|
|
attributes:
|
|
label: pdftract version
|
|
description: Run `pdftract --version` to find out.
|
|
placeholder: 0.1.0
|
|
validations:
|
|
required: true
|
|
|
|
- type: dropdown
|
|
id: install_method
|
|
attributes:
|
|
label: Installation method
|
|
description: How did you install pdftract?
|
|
options:
|
|
- cargo install
|
|
- cargo binstall
|
|
- Homebrew
|
|
- Docker
|
|
- pip (PyO3 bindings)
|
|
- Compiled from source
|
|
- Pre-built binary
|
|
- Other
|
|
validations:
|
|
required: true
|
|
|
|
- type: input
|
|
id: os
|
|
attributes:
|
|
label: Operating system and architecture
|
|
description: e.g., Ubuntu 22.04 aarch64, macOS 14 x86_64, Windows 11
|
|
placeholder: Ubuntu 22.04 aarch64
|
|
validations:
|
|
required: true
|
|
|
|
- type: textarea
|
|
id: pdf_file
|
|
attributes:
|
|
label: PDF file
|
|
description: Please attach the PDF file that causes the bug. If the file is confidential, describe its characteristics in detail.
|
|
placeholder: Attach the PDF file or describe: This is a 50-page scientific paper with tables generated by LaTeX...
|
|
validations:
|
|
required: false
|
|
|
|
- type: textarea
|
|
id: additional_context
|
|
attributes:
|
|
label: Additional context
|
|
description: Add any other context, screenshots, or related issues here.
|
|
placeholder: |
|
|
- Related issue: #123
|
|
- Workaround: ...
|
|
validations:
|
|
required: false
|
|
|
|
- type: checkboxes
|
|
id: terms
|
|
attributes:
|
|
label: Code of Conduct
|
|
description: By submitting this issue, you agree to follow our Code of Conduct
|
|
options:
|
|
- label: I agree to follow the Code of Conduct
|
|
required: true
|