jedarden/pdftract
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
pdftract/.github/PULL_REQUEST_TEMPLATE.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.9 KiB
Raw Blame History

Pull Request

Linked Issue or RFC

Closes #(issue number)

Scope Statement

Which Phase / which Acceptance Scenario does this PR address?

  • Phase: (e.g., Phase 2 - Font Encoding)
  • Acceptance Scenario: (e.g., AS-2.3 - Embedded CMap with predefined CID->Unicode mapping)

Summary

Brief description of what this PR does and why it's necessary.

Changes Made

  • List the main changes here
  • Include file paths and key functions modified
  • Note any breaking changes

Test Plan

How did you verify this works?

  • Unit tests pass (cargo test --workspace --features default)
  • Integration tests pass
  • Manual testing completed

Test Evidence

Attach or paste:

  • Terminal output from test runs
  • Screenshots (for UI changes)
  • Example PDF files processed (before/after)

Performance Impact

If this PR touches hot-path code (parsing, text extraction, encoding resolution):

  • No performance impact (CI changes, documentation, etc.)
  • Performance improvement (include benchmarks)
  • Performance regression (include justification)

Benchmark Results (if applicable)

(paste `cargo bench` output here)

Checklist

  • My code follows the style guidelines of this project (cargo fmt)
  • I have performed a self-review of my code
  • I have commented my code where necessary, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings (cargo clippy)
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing tests pass locally with cargo test --workspace --features default
  • I have signed off my commits (git commit -s) per the DCO

Additional Notes

Any additional context, screenshots, or considerations for the reviewer.

Note: See CONTRIBUTING.md for development setup, local validation checklist, and commit message guidelines.