pdftract/.github/ISSUE_TEMPLATE/bug_report.md
jedarden 97fecb7b4b docs(contributing): add Argo-CI caveat, DCO sign-off, and contributor templates
- Restructured CONTRIBUTING.md with all nine required sections:
  - Project licensing (MIT OR Apache-2.0, DCO sign-off required)
  - Code of conduct (Contributor Covenant v2.1)
  - Security reporting (link to SECURITY.md)
  - Development setup (with OCR dependencies)
  - Local validation checklist (6 commands matching pdftract-ci)
  - CI on forks caveat (maintainer-triggered, 48-hour response)
  - PR template requirements
  - Commit message style (Conventional Commits)
  - Issue triage

- Created CODE_OF_CONDUCT.md (Contributor Covenant v2.1)

- Created .github/PULL_REQUEST_TEMPLATE.md with required fields:
  - Linked issue or RFC
  - Scope statement (Phase / Acceptance Scenario)
  - Test plan
  - Manual-test evidence
  - Performance impact

- Created issue templates:
  - bug_report.md (with pdftract doctor output requirement)
  - feature_request.md (with use case and proposed solution)
  - performance_regression.md (with baseline vs current)

- Updated README.md with Contributing section linking to CONTRIBUTING.md

- Added footer links to CONTRIBUTING.md in all templates

Closes: pdftract-i9rk

Verification: notes/pdftract-i9rk.md
Signed-off-by: jedarden <github@jedarden.com>
2026-05-24 06:00:48 -04:00

1.5 KiB

name about title labels assignees
Bug report Report a problem with pdftract [BUG] bug

Bug Description

A clear and concise description of what the bug is.

PDF File That Triggered the Bug

IMPORTANT: Please attach the PDF file that causes the bug. If the file is confidential, please sanitize it first or describe the issue in detail.

  • File: (attach PDF or describe the issue)
  • File size: (if applicable)
  • PDF generator: (e.g., Acrobat, Word, Ghostscript)

pdftract doctor Output

REQUIRED: Run pdftract doctor and paste the output here.

(paste output here)

Steps to Reproduce

  1. Run this command: ...
  2. With this PDF file: ...
  3. See this error: ...

Expected Behavior

What should have happened?

Actual Behavior

What actually happened? Include error messages, stack traces, or incorrect output.

Environment

  • OS: (e.g., Ubuntu 22.04, macOS 14, Windows 11)
  • pdftract version: (run pdftract --version)
  • Installation method: (e.g., cargo install, brew, compiled from source)
  • Rust version: (run rustc --version)

Additional Context

Add any other context about the problem here:

  • Logs (attach or paste)
  • Screenshots (if applicable)
  • Related issues or PRs
  • Workarounds you've found

Note: For help with development or contributing to pdftract, see CONTRIBUTING.md.

  • Logs (attach or paste)
  • Screenshots (if applicable)
  • Related issues or PRs
  • Workarounds you've found