|
| 1 | +# Manual GitHub Issue Creation Guide |
| 2 | + |
| 3 | +Since automatic issue creation requires PSPDFKit organization permissions, please follow these steps to manually create the issues: |
| 4 | + |
| 5 | +## Prerequisites |
| 6 | +1. Ensure you have write access to the PSPDFKit/nutrient-dws-client-python repository |
| 7 | +2. Or request someone with appropriate permissions to create these issues |
| 8 | + |
| 9 | +## Issue Templates Location |
| 10 | +All issue templates are in the `github_issues/` directory with the following structure: |
| 11 | +- `00_roadmap.md` - Overall enhancement roadmap (create this first) |
| 12 | +- `01_multi_language_ocr.md` - Multi-language OCR support |
| 13 | +- `02_image_watermark.md` - Image watermark support |
| 14 | +- `03_selective_flattening.md` - Selective annotation flattening |
| 15 | +- `04_create_redactions.md` - Create redactions method |
| 16 | +- `05_import_annotations.md` - Import annotations feature |
| 17 | +- `06_extract_pages.md` - Extract page range method |
| 18 | +- `07_convert_to_pdfa.md` - PDF/A conversion |
| 19 | +- `08_convert_to_images.md` - Image extraction |
| 20 | +- `09_extract_content_json.md` - JSON content extraction |
| 21 | +- `10_convert_to_office.md` - Office format conversion |
| 22 | +- `11_ai_redaction.md` - AI-powered redaction |
| 23 | +- `12_digital_signature.md` - Digital signature support |
| 24 | +- `13_batch_processing.md` - Batch processing method |
| 25 | + |
| 26 | +## Steps to Create Issues |
| 27 | + |
| 28 | +### Option 1: Using GitHub Web Interface |
| 29 | +1. Go to https://github.com/PSPDFKit/nutrient-dws-client-python/issues |
| 30 | +2. Click "New issue" |
| 31 | +3. For each template file: |
| 32 | + - Copy the title from the first line (after the #) |
| 33 | + - Copy the entire content into the issue body |
| 34 | + - Add the labels listed at the bottom of each template |
| 35 | + - Click "Submit new issue" |
| 36 | + |
| 37 | +### Option 2: Using GitHub CLI (if you have permissions) |
| 38 | +If you get appropriate permissions, you can run: |
| 39 | + |
| 40 | +```bash |
| 41 | +cd /Users/admin/Projects/nutrient-dws-client-python |
| 42 | + |
| 43 | +# Create the roadmap issue first |
| 44 | +gh issue create \ |
| 45 | + --title "Enhancement Roadmap: Comprehensive Feature Plan" \ |
| 46 | + --body-file github_issues/00_roadmap.md \ |
| 47 | + --label "roadmap,enhancement,documentation" |
| 48 | + |
| 49 | +# Then create individual feature issues |
| 50 | +for i in {01..13}; do |
| 51 | + title=$(head -n 1 github_issues/${i}_*.md | sed 's/# //') |
| 52 | + labels=$(tail -n 1 github_issues/${i}_*.md | sed 's/- //') |
| 53 | + gh issue create \ |
| 54 | + --title "$title" \ |
| 55 | + --body-file github_issues/${i}_*.md \ |
| 56 | + --label "$labels" |
| 57 | +done |
| 58 | +``` |
| 59 | + |
| 60 | +### Option 3: Request Organization Access |
| 61 | +1. Contact the PSPDFKit organization administrators |
| 62 | +2. Request contributor access to the nutrient-dws-client-python repository |
| 63 | +3. Once granted, use the GitHub CLI commands above |
| 64 | + |
| 65 | +## Issue Organization |
| 66 | + |
| 67 | +### Priority Labels |
| 68 | +- 🔵 `priority-1`: Enhanced existing methods |
| 69 | +- 🟢 `priority-2`: Core missing methods |
| 70 | +- 🟡 `priority-3`: Format conversion methods |
| 71 | +- 🟠 `priority-4`: Advanced features |
| 72 | + |
| 73 | +### Implementation Phases |
| 74 | +- **Phase 1** (1-2 months): Issues 01, 02, 04 |
| 75 | +- **Phase 2** (2-3 months): Issues 07, 08, 05 |
| 76 | +- **Phase 3** (3-4 months): Issues 09, 10, 11 |
| 77 | +- **Phase 4** (4-6 months): Issues 12, 13 |
| 78 | + |
| 79 | +## Notes |
| 80 | +- Create the roadmap issue (00) first as it provides context for all others |
| 81 | +- Each issue is self-contained with implementation details, testing requirements, and examples |
| 82 | +- Issues are numbered in suggested implementation order within their priority groups |
| 83 | +- All issues follow the same format for consistency |
0 commit comments