Reporting Issues โ
Found a bug or have a feature idea? Here's how to let us know.
๐ Bug Reports โ
Use our structured bug report form to ensure we can reproduce and fix the issue quickly:
๐ Open a Bug Report
What to include โ
| Field | Required | Example |
|---|---|---|
| Description | โ | "PDF extraction returns empty entities for scanned documents" |
| Steps to reproduce | โ | Minimal code snippet or API calls to trigger the bug |
| Expected behaviour | โ | "Should return 5 extracted entities" |
| Actual behaviour | โ | "Returns empty list with no error" |
| Purple8 version | โ | 0.7.0 โ check with pip show purple8-docintel |
| Python version | โ | 3.11.9 โ check with python --version |
| OS | โ | macOS 15.2, Ubuntu 22.04, etc. |
| Installation method | โ | pip install / Docker / source |
| Logs / stack traces | Optional | Paste any error output |
Tips for a great bug report โ
- Minimal reproduction โ strip your code down to the smallest example that triggers the bug
- Include the full stack trace โ don't truncate error messages
- Check your version โ make sure you're on the latest release before reporting:bash
pip install --upgrade "purple8-docintel @ git+ssh://git@github.com/Purple8-Technologies/Purple8-DocIntel.git@main" - Search existing issues โ someone may have already reported it: Search issues
๐ก Feature Requests โ
Have an idea for a new feature or improvement? We'd love to hear it:
What to include โ
| Field | Required | Example |
|---|---|---|
| Problem / motivation | โ | What problem does this solve? Why do you need it? |
| Proposed solution | โ | How you'd like it to work (API examples welcome) |
| Alternatives considered | Optional | Workarounds you've tried |
| Area | โ | Which part of DocIntel this relates to |
Feature request areas โ
Our issue template includes these categories:
- Extraction Pipeline
- REST API / Server
- PDF Parser
- Office Parsers (DOCX, XLSX, PPTX)
- HTML / Email Parser
- OCR Engine
- Connectors (SharePoint, Confluence, S3, Webhook)
- Domain Profiles
- Licensing
- Docker / Deployment
- Documentation
- SDKs / Client Libraries
๐ Security Vulnerabilities โ
Do not open a public issue for security vulnerabilities.
Report them privately to security@purple8.ai. See the full Security Policy for details on our responsible disclosure process and response timeline.
Where to Find Issues โ
- All open issues: github.com/Purple8-Technologies/Purple8-DocIntel/issues
- Bugs only: Filter by bug label
- Feature requests: Filter by enhancement label
Other Channels โ
| Topic | Contact |
|---|---|
| General questions | hello@purple8.ai |
| Enterprise enquiries | enterprise@purple8.ai |
| Security reports | security@purple8.ai |
| Documentation | docs.docintel.purple8.ai |