- 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>
48 lines
1.3 KiB
Markdown
48 lines
1.3 KiB
Markdown
---
|
|
name: Feature request
|
|
about: Suggest an enhancement or new feature for pdftract
|
|
title: '[FEATURE] '
|
|
labels: enhancement
|
|
assignees: ''
|
|
---
|
|
|
|
## Feature Description
|
|
|
|
A clear and concise description of the feature you'd like to see added.
|
|
|
|
## Use Case
|
|
|
|
Describe the specific problem this feature would solve. Who would benefit from this feature?
|
|
|
|
**Example:**
|
|
"As a user working with scientific papers, I need to extract tables as structured data so that I can analyze experimental results without manual transcription."
|
|
|
|
## Proposed Solution
|
|
|
|
How do you envision this feature working?
|
|
|
|
- **API:** What would the API look like?
|
|
- **CLI:** What flags or commands would be added?
|
|
- **Output format:** JSON, Markdown, CSV, etc.?
|
|
|
|
## Alternatives Considered
|
|
|
|
Describe any alternative solutions or workarounds you've considered. Why aren't they sufficient?
|
|
|
|
## Additional Context
|
|
|
|
Add any other context about the feature request here:
|
|
|
|
- Links to related issues or PRs
|
|
- References to similar features in other tools
|
|
- Example PDF files that demonstrate the need
|
|
- Draft API designs or pseudocode
|
|
|
|
---
|
|
|
|
**Note:** For help with development or contributing to pdftract, see [`CONTRIBUTING.md`](../../CONTRIBUTING.md).
|
|
|
|
- Links to related issues or PRs
|
|
- References to similar features in other tools
|
|
- Example PDF files that demonstrate the need
|
|
- Draft API designs or pseudocode
|