Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
105 changes: 105 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,105 @@
name: Bug Report
description: Report a bug or issue with the IIIF Page Viewer
title: "[Bug]: "
labels: ["bug", "needs-triage"]
body:
- type: markdown
attributes:
value: |
Thanks for taking the time to report a bug! Please fill out the following information to help us understand and reproduce the issue.

- type: textarea
id: description
attributes:
label: Bug Description
description: A clear and concise description of what the bug is.
placeholder: Describe what happened and what you expected to happen.
validations:
required: true

- type: textarea
id: reproduction
attributes:
label: Steps to Reproduce
description: Please provide detailed steps to reproduce the issue.
placeholder: |
1. Go to '...'
2. Load IIIF manifest '...'
3. Click on '...'
4. See error
validations:
required: true

- type: textarea
id: iiif-manifest
attributes:
label: IIIF Manifest URL
description: If the issue is related to a specific IIIF manifest, please provide the URL.
placeholder: https://example.com/iiif/manifest.json
validations:
required: false

- type: dropdown
id: browser
attributes:
label: Browser
description: Which browser are you using?
options:
- Chrome
- Firefox
- Safari
- Edge
- Other (specify in additional context)
validations:
required: true

- type: input
id: browser-version
attributes:
label: Browser Version
description: What version of the browser are you using?
placeholder: e.g., Chrome 118.0.5993.88
validations:
required: true

- type: dropdown
id: device
attributes:
label: Device Type
description: What type of device are you using?
options:
- Desktop/Laptop
- Mobile Phone
- Tablet
- Other
validations:
required: true

- type: textarea
id: console-errors
attributes:
label: Console Errors
description: Please check the browser's developer console for errors and paste them here.
placeholder: |
Error: Failed to fetch manifest
at IIIFDataService.fetchCanvasData (iiif-data-service.js:45)
render: shell

- type: textarea
id: additional-context
attributes:
label: Additional Context
description: Add any other context about the problem here, including screenshots if helpful.
validations:
required: false

- type: checkboxes
id: testing
attributes:
label: Testing Checklist
description: Have you tested this issue?
options:
- label: I have tested this in multiple browsers
- label: I have checked the browser console for errors
- label: I have verified the IIIF manifest is valid (if applicable)
- label: I have searched existing issues for duplicates
14 changes: 14 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
blank_issues_enabled: false
contact_links:
- name: 💬 Questions and Discussions
url: https://github.com/CenterForDigitalHumanities/Page-Viewer/discussions
about: Ask questions and discuss ideas with the community
- name: 📚 IIIF Community
url: https://iiif.io/community/
about: Join the broader IIIF community for general IIIF questions
- name: 🔧 IIIF Technical Questions
url: https://groups.google.com/forum/#!forum/iiif-discuss
about: Technical questions about IIIF standards and implementation
- name: 🏛️ Center for Digital Humanities
url: https://digitalhumanities.wustl.edu/
about: Learn more about the Center for Digital Humanities at Washington University in St. Louis
131 changes: 131 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,131 @@
name: Feature Request
description: Suggest a new feature or enhancement for the IIIF Page Viewer
title: "[Feature]: "
labels: ["enhancement", "needs-triage"]
body:
- type: markdown
attributes:
value: |
Thanks for suggesting a feature! Please provide as much detail as possible to help us understand your request.

- type: textarea
id: problem
attributes:
label: Problem Statement
description: What problem does this feature solve? Is your feature request related to a problem?
placeholder: I'm always frustrated when...
validations:
required: true

- type: textarea
id: solution
attributes:
label: Proposed Solution
description: Describe the solution you'd like to see implemented.
placeholder: I would like to see...
validations:
required: true

- type: textarea
id: alternatives
attributes:
label: Alternative Solutions
description: Describe any alternative solutions or features you've considered.
placeholder: Another approach could be...
validations:
required: false

- type: dropdown
id: feature-type
attributes:
label: Feature Type
description: What type of feature is this?
options:
- IIIF Standard Compliance
- User Interface Enhancement
- Accessibility Improvement
- Performance Optimization
- Developer Experience
- Documentation
- Integration/API
- Other
validations:
required: true

- type: dropdown
id: priority
attributes:
label: Priority Level
description: How important is this feature to you?
options:
- Low - Nice to have
- Medium - Would be helpful
- High - Important for my use case
- Critical - Blocking my project
validations:
required: true

- type: textarea
id: use-case
attributes:
label: Use Case
description: Describe your specific use case for this feature.
placeholder: |
In my digital humanities project, I need to...
The current workflow is...
This feature would help by...
validations:
required: true

- type: textarea
id: iiif-context
attributes:
label: IIIF Context
description: How does this relate to IIIF standards or best practices?
placeholder: This aligns with IIIF Presentation API v3 by...
validations:
required: false

- type: textarea
id: implementation-ideas
attributes:
label: Implementation Ideas
description: Do you have any ideas about how this could be implemented?
placeholder: |
This could be implemented by:
1. Adding a new method to...
2. Modifying the UI to...
3. Supporting additional IIIF properties...
validations:
required: false

- type: textarea
id: examples
attributes:
label: Examples or References
description: Provide links to similar features in other tools or examples of this functionality.
placeholder: |
- Similar feature in Tool X: https://example.com
- IIIF specification reference: https://iiif.io/api/...
- Example manifest that would benefit: https://...
validations:
required: false

- type: checkboxes
id: contribution
attributes:
label: Contribution
description: Are you interested in contributing to this feature?
options:
- label: I would like to work on implementing this feature
- label: I can help with testing this feature
- label: I can provide additional IIIF manifests for testing
- label: I can help with documentation for this feature

- type: textarea
id: additional-context
attributes:
label: Additional Context
description: Add any other context, screenshots, or mockups about the feature request here.
validations:
required: false
Loading