pdftract/.github/ISSUE_TEMPLATE/documentation.yml
jedarden 2573dba8ed docs(pdftract-f29c): implement GitHub Issue Forms and PR templates
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>
2026-05-24 06:43:48 -04:00

61 lines
1.8 KiB
YAML

name: Documentation issue
description: Report a problem or suggest an improvement to the documentation
title: '[DOCS] '
labels: [documentation]
body:
- type: markdown
attributes:
value: |
Thanks for taking the time to improve the documentation! Your feedback helps us make pdftract more accessible.
- type: input
id: page_url
attributes:
label: Documentation page URL
description: Which page are you referring to?
placeholder: https://jedarden.com/pdftract/docs/...
validations:
required: true
- type: dropdown
id: doc_type
attributes:
label: What type of documentation issue is this?
description: This helps us route your issue to the right team.
options:
- Typo or grammar error
- Confusing or unclear explanation
- Missing information
- Outdated information
- Suggested improvement
- Code example issue
- Other
validations:
required: true
- type: textarea
id: description
attributes:
label: Issue description
description: Please describe the documentation issue clearly and concisely.
placeholder: The explanation of X is confusing because...
validations:
required: true
- type: textarea
id: suggested_change
attributes:
label: Suggested change
description: If you have a specific improvement in mind, please describe it here. You can also provide a pull request!
placeholder: Instead of saying X, say Y...
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