|
| 1 | +# How to Create GitHub Sub-Issues for Migration |
| 2 | + |
| 3 | +This guide explains how to create GitHub issues from the sub-issue templates in this directory. |
| 4 | + |
| 5 | +## Quick Start |
| 6 | + |
| 7 | +For each of the 11 sub-issues, follow these steps: |
| 8 | + |
| 9 | +### Step 1: Open the Template |
| 10 | +Navigate to the appropriate markdown file: |
| 11 | +- `01-device-users.md` |
| 12 | +- `02-password-settings.md` |
| 13 | +- `03-user-administration.md` |
| 14 | +- `04-navigation-menu.md` |
| 15 | +- `05-folders.md` |
| 16 | +- `06-application-settings.md` |
| 17 | +- `07-searchable-lists.md` |
| 18 | +- `08-selectable-lists.md` |
| 19 | +- `09-workers.md` |
| 20 | +- `10-profile-settings.md` |
| 21 | +- `11-eform-visual-editor-create.md` |
| 22 | + |
| 23 | +### Step 2: Copy the Content |
| 24 | +Open the file and copy its entire content (the markdown text). |
| 25 | + |
| 26 | +### Step 3: Create GitHub Issue |
| 27 | +1. Go to https://github.com/microting/eform-angular-frontend/issues/new |
| 28 | +2. Paste the copied content into the issue description |
| 29 | +3. Set the title: |
| 30 | + - For issue 01: "Migrate Device Users Tests to Cypress" |
| 31 | + - For issue 02: "Migrate Password Settings Tests to Cypress" |
| 32 | + - etc. (use the title from each file) |
| 33 | + |
| 34 | +### Step 4: Add Labels |
| 35 | +Add appropriate labels to categorize the issue: |
| 36 | +- `testing` - All issues |
| 37 | +- `cypress` - All issues |
| 38 | +- `e2e` - All issues |
| 39 | +- `migration` - All issues |
| 40 | +- `high-priority` - Issues 01, 02, 03, 11 |
| 41 | +- `medium-priority` - Issues 04-10 |
| 42 | + |
| 43 | +### Step 5: Add to Project (Optional) |
| 44 | +If you have a project board for the migration: |
| 45 | +1. Add the issue to the project |
| 46 | +2. Set status to "To Do" or "Backlog" |
| 47 | + |
| 48 | +### Step 6: Assign (Optional) |
| 49 | +- Assign to yourself or the team member who will work on it |
| 50 | +- Or leave unassigned if you want to let people self-assign |
| 51 | + |
| 52 | +### Step 7: Link to Parent Issue (Optional) |
| 53 | +If there's a parent/epic issue for the overall migration: |
| 54 | +- Reference it in the issue description |
| 55 | +- Use "Part of #XXX" at the top of the description |
| 56 | + |
| 57 | +## Example: Creating Issue #01 |
| 58 | + |
| 59 | +1. Open `01-device-users.md` |
| 60 | +2. Copy all content |
| 61 | +3. Go to GitHub Issues → New Issue |
| 62 | +4. Paste content |
| 63 | +5. Title: "Migrate Device Users Tests to Cypress" |
| 64 | +6. Labels: `testing`, `cypress`, `e2e`, `migration`, `high-priority` |
| 65 | +7. (Optional) Assign to developer |
| 66 | +8. Create issue |
| 67 | + |
| 68 | +## Bulk Creation Script (Optional) |
| 69 | + |
| 70 | +If you want to create all issues programmatically, you can use the GitHub CLI: |
| 71 | + |
| 72 | +```bash |
| 73 | +# Install GitHub CLI if needed |
| 74 | +# https://cli.github.com/ |
| 75 | + |
| 76 | +# For each sub-issue |
| 77 | +gh issue create \ |
| 78 | + --title "Migrate Device Users Tests to Cypress" \ |
| 79 | + --body-file migration-issues/01-device-users.md \ |
| 80 | + --label testing,cypress,e2e,migration,high-priority |
| 81 | + |
| 82 | +gh issue create \ |
| 83 | + --title "Migrate Password Settings Tests to Cypress" \ |
| 84 | + --body-file migration-issues/02-password-settings.md \ |
| 85 | + --label testing,cypress,e2e,migration,high-priority |
| 86 | + |
| 87 | +# ... repeat for all 11 issues |
| 88 | +``` |
| 89 | + |
| 90 | +### Full Bulk Script |
| 91 | + |
| 92 | +Save this as `create-all-issues.sh`: |
| 93 | + |
| 94 | +```bash |
| 95 | +#!/bin/bash |
| 96 | + |
| 97 | +# Ensure you're in the repository root |
| 98 | +cd "$(dirname "$0")/.." |
| 99 | + |
| 100 | +# Issue 01 |
| 101 | +gh issue create \ |
| 102 | + --title "Migrate Device Users Tests to Cypress" \ |
| 103 | + --body-file migration-issues/01-device-users.md \ |
| 104 | + --label testing,cypress,e2e,migration,high-priority |
| 105 | + |
| 106 | +# Issue 02 |
| 107 | +gh issue create \ |
| 108 | + --title "Migrate Password Settings Tests to Cypress" \ |
| 109 | + --body-file migration-issues/02-password-settings.md \ |
| 110 | + --label testing,cypress,e2e,migration,high-priority |
| 111 | + |
| 112 | +# Issue 03 |
| 113 | +gh issue create \ |
| 114 | + --title "Migrate User Administration Tests to Cypress" \ |
| 115 | + --body-file migration-issues/03-user-administration.md \ |
| 116 | + --label testing,cypress,e2e,migration,high-priority |
| 117 | + |
| 118 | +# Issue 04 |
| 119 | +gh issue create \ |
| 120 | + --title "Migrate Navigation Menu Tests to Cypress" \ |
| 121 | + --body-file migration-issues/04-navigation-menu.md \ |
| 122 | + --label testing,cypress,e2e,migration,medium-priority |
| 123 | + |
| 124 | +# Issue 05 |
| 125 | +gh issue create \ |
| 126 | + --title "Migrate Folders Tests to Cypress" \ |
| 127 | + --body-file migration-issues/05-folders.md \ |
| 128 | + --label testing,cypress,e2e,migration,medium-priority |
| 129 | + |
| 130 | +# Issue 06 |
| 131 | +gh issue create \ |
| 132 | + --title "Migrate Application Settings Tests to Cypress" \ |
| 133 | + --body-file migration-issues/06-application-settings.md \ |
| 134 | + --label testing,cypress,e2e,migration,medium-priority |
| 135 | + |
| 136 | +# Issue 07 |
| 137 | +gh issue create \ |
| 138 | + --title "Migrate Searchable Lists Tests to Cypress" \ |
| 139 | + --body-file migration-issues/07-searchable-lists.md \ |
| 140 | + --label testing,cypress,e2e,migration,medium-priority |
| 141 | + |
| 142 | +# Issue 08 |
| 143 | +gh issue create \ |
| 144 | + --title "Migrate Selectable Lists Tests to Cypress" \ |
| 145 | + --body-file migration-issues/08-selectable-lists.md \ |
| 146 | + --label testing,cypress,e2e,migration,medium-priority |
| 147 | + |
| 148 | +# Issue 09 |
| 149 | +gh issue create \ |
| 150 | + --title "Migrate Workers Tests to Cypress" \ |
| 151 | + --body-file migration-issues/09-workers.md \ |
| 152 | + --label testing,cypress,e2e,migration,medium-priority |
| 153 | + |
| 154 | +# Issue 10 |
| 155 | +gh issue create \ |
| 156 | + --title "Migrate Profile Settings Tests to Cypress" \ |
| 157 | + --body-file migration-issues/10-profile-settings.md \ |
| 158 | + --label testing,cypress,e2e,migration,medium-priority |
| 159 | + |
| 160 | +# Issue 11 |
| 161 | +gh issue create \ |
| 162 | + --title "Migrate eForm Visual Editor Create Tests to Cypress" \ |
| 163 | + --body-file migration-issues/11-eform-visual-editor-create.md \ |
| 164 | + --label testing,cypress,e2e,migration,high-priority |
| 165 | + |
| 166 | +echo "All 11 migration issues created successfully!" |
| 167 | +``` |
| 168 | + |
| 169 | +Make it executable: |
| 170 | +```bash |
| 171 | +chmod +x create-all-issues.sh |
| 172 | +``` |
| 173 | + |
| 174 | +Run it: |
| 175 | +```bash |
| 176 | +./create-all-issues.sh |
| 177 | +``` |
| 178 | + |
| 179 | +## After Creating Issues |
| 180 | + |
| 181 | +1. **Review Issues**: Check that all issues were created correctly |
| 182 | +2. **Prioritize**: Ensure high-priority issues are addressed first |
| 183 | +3. **Link Issues**: If using a project board, link issues appropriately |
| 184 | +4. **Notify Team**: Let team members know issues are ready to be worked on |
| 185 | +5. **Track Progress**: Update `WDIO_TO_CYPRESS_MIGRATION.md` as issues are completed |
| 186 | + |
| 187 | +## Tips |
| 188 | + |
| 189 | +- **Don't create all at once**: Consider creating high-priority issues first, then medium-priority as work progresses |
| 190 | +- **Add milestones**: Create a milestone for "E2E Test Migration" and add all issues to it |
| 191 | +- **Use templates**: If you have issue templates in `.github/ISSUE_TEMPLATE/`, you can adapt these sub-issues to fit that format |
| 192 | +- **Include context**: Add a link to `WDIO_TO_CYPRESS_MIGRATION.md` in each issue for broader context |
| 193 | + |
| 194 | +## Questions? |
| 195 | + |
| 196 | +If you have questions about creating these issues, refer to: |
| 197 | +- [GitHub Issues Documentation](https://docs.github.com/en/issues) |
| 198 | +- [GitHub CLI Documentation](https://cli.github.com/manual/) |
| 199 | +- [Migration Plan](../WDIO_TO_CYPRESS_MIGRATION.md) |
0 commit comments