name: Feature Request
description: Suggest an idea for ReadPDFx
title: "[FEATURE] "
labels: ["enhancement"]
body:
- type: markdown
attributes:
value: |
Thanks for suggesting a new feature! Please provide as much detail as possible.
- type: textarea
id: problem
attributes:
label: Problem Description
description: Is your feature request related to a problem? Please describe.
placeholder: A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
validations:
required: true
- type: textarea
id: solution
attributes:
label: Proposed Solution
description: Describe the solution you'd like
placeholder: A clear and concise description of what you want to happen.
validations:
required: true
- type: textarea
id: alternatives
attributes:
label: Alternative Solutions
description: Describe any alternative solutions or features you've considered
placeholder: A clear and concise description of any alternative solutions or features you've considered.
- type: dropdown
id: category
attributes:
label: Feature Category
description: What category does this feature fall into?
options:
- OCR Processing
- PDF Handling
- MCP Protocol
- Client Integration
- Performance
- Documentation
- Testing
- DevOps/Infrastructure
- Other
validations:
required: true
- type: dropdown
id: priority
attributes:
label: Priority
description: How important is this feature to you?
options:
- Low - Nice to have
- Medium - Would improve workflow
- High - Important for my use case
- Critical - Blocking my use case
validations:
required: true
- type: textarea
id: use-case
attributes:
label: Use Case
description: Describe your specific use case for this feature
placeholder: |
Explain how you would use this feature and why it would be beneficial.
Include any specific scenarios or workflows.
validations:
required: true
- type: textarea
id: implementation
attributes:
label: Implementation Ideas
description: Do you have any ideas on how this could be implemented?
placeholder: |
If you have technical knowledge, please share any implementation ideas.
This could include:
- API changes
- New configuration options
- Dependencies that might be needed
- Potential challenges
- type: checkboxes
id: compatibility
attributes:
label: Compatibility Considerations
description: Please check all that apply
options:
- label: This feature should maintain backwards compatibility
- label: This feature may require breaking changes
- label: This feature should work with all MCP clients
- label: This feature is specific to certain clients
- type: textarea
id: examples
attributes:
label: Examples
description: Provide examples of how this feature would work
placeholder: |
Show examples of:
- API requests/responses
- Configuration changes
- User interface changes
- Expected behavior
- type: checkboxes
id: willingness
attributes:
label: Contribution
description: Are you willing to help implement this feature?
options:
- label: I'm willing to submit a pull request for this feature
- label: I can help with testing
- label: I can help with documentation
- label: I can provide feedback during development
- type: textarea
id: additional-context
attributes:
label: Additional Context
description: Add any other context, screenshots, or examples about the feature request here
