diff --git a/.env.example b/.env.example index 41008f0..249f9d6 100644 --- a/.env.example +++ b/.env.example @@ -1,2 +1,3 @@ # Anthropic API Key for Claude models ANTHROPIC_API_KEY=your_api_key_here +MCP_SERVER_URL=https://your-mcp-server/mcp diff --git a/docs/testing/research-workflow-test-report-10577.md b/docs/testing/research-workflow-test-report-10577.md new file mode 100644 index 0000000..461324c --- /dev/null +++ b/docs/testing/research-workflow-test-report-10577.md @@ -0,0 +1,187 @@ +> cht-agent@0.1.0 research +> node dist/cli/research.js tickets/10577.md + +╔════════════════════════════════════════════════════════════════╗ +║ CHT Multi-Agent System - Research CLI ║ +╚════════════════════════════════════════════════════════════════╝ + +📄 Loading ticket from: /Users/andra/Documents/GitHub/cht-agent/tickets/10577.md + +✅ Ticket parsed successfully! + +🤖 Initializing Research Supervisor... + +📋 Issue Details: +━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ +Title: Add ability to filter tasks +Type: feature +Priority: high +Domain: tasks-and-targets +Components: webapp/src/ts/modules/tasks, webapp/src/ts/components/filters, Report filtering feature (existing pattern to follow), task.action.form, task.name +━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + +🔍 Running Research Phase... + + +======================================== +RESEARCH SUPERVISOR - Starting Research Phase +======================================== +Issue: Add ability to filter tasks +Domain: tasks-and-targets +Components: webapp/src/ts/modules/tasks, webapp/src/ts/components/filters, Report filtering feature (existing pattern to follow), task.action.form, task.name +======================================== + + +=== DOCUMENTATION SEARCH NODE === + +[Documentation Search Agent] Starting documentation search... +[Documentation Search Agent] Domain: tasks-and-targets +[Documentation Search Agent] Issue: Add ability to filter tasks +[Documentation Search Agent] Search query: tasks-and-targets webapp/src/ts/modules/tasks webapp/src/ts/components/filters Report filtering feature (existing pattern to follow) task.action.form task.name Add ability to filter tasks # Description + +When CHWs provide services in the community, they face challenges navigating the CHT tasks. With numerous tasks listed, it often becomes difficult to scroll through and identify specifi +[Documentation Search Agent] Found 10 documentation references +[Documentation Search Agent] Confidence: 0.85 + +=== CONTEXT ANALYSIS NODE === + +[Context Analysis Agent] Starting context analysis... +[Context Analysis Agent] Domain: tasks-and-targets +[Context Analysis Agent] No resolved issues found for domain: tasks-and-targets +[Context Analysis Agent] Found 0 similar past issues +[Context Analysis Agent] Extracted 0 reusable patterns +[Context Analysis Agent] Found 0 relevant design decisions +[Context Analysis Agent] Generated 3 recommendations + +=== GENERATE PLAN NODE === +[Research Supervisor] Generating orchestration plan... +[Research Supervisor] Plan generated successfully + +======================================== +RESEARCH SUPERVISOR - Research Phase Complete +======================================== +Final Phase: complete +Errors: 0 +======================================== + + +╔════════════════════════════════════════════════════════════════╗ +║ RESEARCH RESULTS ║ +╚════════════════════════════════════════════════════════════════╝ + +⏱️ Duration: 34.72 seconds +📊 Phase: complete +❌ Errors: 0 + +📚 DOCUMENTATION SEARCH RESULTS +────────────────────────────────────────────────────────────────────── +Source: kapa-ai +Confidence: 85% + +Documentation References (10): + +1. Tasks sidebar filter.component.ts#L1 L39 + URL: https://github.com/medic/cht-core/blob/master/webapp/src/ts/modules/tasks/tasks-sidebar-filter.component.ts#L1-L39 + Topics: tasks-and-targets + +2. Tasks sidebar filter.component.ts#L40 L168 + URL: https://github.com/medic/cht-core/blob/master/webapp/src/ts/modules/tasks/tasks-sidebar-filter.component.ts#L40-L168 + Topics: tasks-and-targets + +3. Task type filter.component.ts + URL: https://github.com/medic/cht-core/blob/master/webapp/src/ts/components/filters/task-type-filter/task-type-filter.component.ts + Topics: tasks-and-targets + +4. Tasks.component.ts#L159 L225 + URL: https://github.com/medic/cht-core/blob/master/webapp/src/ts/modules/tasks/tasks.component.ts#L159-L225 + Topics: tasks-and-targets + +5. Tasks group.component.ts#L149 L266 + URL: https://github.com/medic/cht-core/blob/master/webapp/src/ts/modules/tasks/tasks-group.component.ts#L149-L266 + Topics: tasks-and-targets + +6. Tasks content.component.ts#L254 L361 + URL: https://github.com/medic/cht-core/blob/master/webapp/src/ts/modules/tasks/tasks-content.component.ts#L254-L361 + Topics: tasks-and-targets + +7. Tasks content.component.ts#L362 L370 + URL: https://github.com/medic/cht-core/blob/master/webapp/src/ts/modules/tasks/tasks-content.component.ts#L362-L370 + Topics: tasks-and-targets + +8. Tasks content.component.ts#L143 L253 + URL: https://github.com/medic/cht-core/blob/master/webapp/src/ts/modules/tasks/tasks-content.component.ts#L143-L253 + Topics: tasks-and-targets + +9. Tasks.component.ts#L1 L44 + URL: https://github.com/medic/cht-core/blob/master/webapp/src/ts/modules/tasks/tasks.component.ts#L1-L44 + Topics: tasks-and-targets + +10. Tasks route.guard.provider.ts + URL: https://github.com/medic/cht-core/blob/master/webapp/src/ts/modules/tasks/tasks-route.guard.provider.ts + Topics: tasks-and-targets + +Suggested Approaches: + 1. Implement following CHT best practices and existing patterns + +🔎 CONTEXT ANALYSIS RESULTS +────────────────────────────────────────────────────────────────────── +Similar Past Issues: 0 +Reusable Patterns: 0 +Design Decisions: 0 +Historical Success Rate: 50% + +Recommendations: + 1. Ensure comprehensive test coverage for new feature + 2. Update documentation and configuration examples + 3. Validate changes with integration tests before deployment + +📋 ORCHESTRATION PLAN +────────────────────────────────────────────────────────────────────── +Estimated Complexity: HIGH +Estimated Effort: 1 week + +Proposed Approach: + Implement following CHT best practices and existing patterns + +Key Findings: + 1. 10 documentation references found + 2. 0 similar past implementations identified + 3. Historical success rate: 50% + 4. Ensure comprehensive test coverage for new feature + 5. Update documentation and configuration examples + +Implementation Phases (4): + + 1. Setup and Configuration [low] + Set up development environment and review documentation + Components: development environment, documentation + + 2. Core Implementation [high] + Implement Add ability to filter tasks + Components: webapp/src/ts/modules/tasks, webapp/src/ts/components/filters, Report filtering feature (existing pattern to follow), task.action.form, task.name + Dependencies: Setup and Configuration + + 3. Testing [medium] + Write and run unit, integration, and e2e tests + Components: test suite, test data + Dependencies: Core Implementation + + 4. Documentation [low] + Update documentation and configuration examples + Components: docs, examples + Dependencies: Testing + +⚠️ Risk Factors: + 1. No similar past implementations found - breaking new ground + 2. Multiple constraints to satisfy: Filter UX should be consistent with the existing reporting filter feature, Must work offline, Decision needed on whether task type filtering uses `task.action.form` or `task.name` (low-consequence decision), Tasks with multiple actions must be handled correctly when filtering by task type + 3. High priority issue - requires careful attention and thorough testing + 4. Changes span multiple components - requires coordination and integration testing + +╔════════════════════════════════════════════════════════════════╗ +║ Research Phase Complete! ✅ ║ +╚════════════════════════════════════════════════════════════════╝ + +💡 Next Steps: + 1. Review the orchestration plan + 2. Validate research findings + 3. Proceed to Development Phase (coming soon) diff --git a/docs/testing/research-workflow-test-report-10621.md b/docs/testing/research-workflow-test-report-10621.md new file mode 100644 index 0000000..5ff6fb0 --- /dev/null +++ b/docs/testing/research-workflow-test-report-10621.md @@ -0,0 +1,265 @@ +npm run research tickets/10621.md + +> cht-agent@0.1.0 research +> node dist/cli/research.js tickets/10621.md + +╔════════════════════════════════════════════════════════════════╗ +║ CHT Multi-Agent System - Research CLI ║ +╚════════════════════════════════════════════════════════════════╝ + +📄 Loading ticket from: /Users/andra/Documents/GitHub/cht-agent/tickets/10621.md + +✅ Ticket parsed successfully! + +🤖 Initializing Research Supervisor... + +📋 Issue Details: +━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ +Title: Freetext search causes excessive requests when getting a large number of results +Type: bug +Priority: high +Domain: contacts +Components: shared-libs/cht-datasource, shared-libs/search, api/v1/contact/uuid, Nouveau search index integration, DEFAULT_IDS_PAGE_LIMIT, DEFAULT_DOCS_PAGE_LIMIT, getPagedGenerator +━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + +🔍 Running Research Phase... + + +======================================== +RESEARCH SUPERVISOR - Starting Research Phase +======================================== +Issue: Freetext search causes excessive requests when getting a large number of results +Domain: contacts +Components: shared-libs/cht-datasource, shared-libs/search, api/v1/contact/uuid, Nouveau search index integration, DEFAULT_IDS_PAGE_LIMIT, DEFAULT_DOCS_PAGE_LIMIT, getPagedGenerator +======================================== + + +=== DOCUMENTATION SEARCH NODE === + +[Documentation Search Agent] Starting documentation search... +[Documentation Search Agent] Domain: contacts +[Documentation Search Agent] Issue: Freetext search causes excessive requests when getting a large number of results +[Documentation Search Agent] Search query: contacts shared-libs/cht-datasource shared-libs/search api/v1/contact/uuid Nouveau search index integration DEFAULT_IDS_PAGE_LIMIT DEFAULT_DOCS_PAGE_LIMIT getPagedGenerator Freetext search causes excessive requests when getting a large number of results # Description + +Simple freetext search retrieves all results for the search in small batches of 100 instead of using the intended larger page size, causing excessive round-trip requests to the server. +[Documentation Search Agent] Found 29 documentation references +[Documentation Search Agent] Confidence: 0.85 + +=== CONTEXT ANALYSIS NODE === + +[Context Analysis Agent] Starting context analysis... +[Context Analysis Agent] Domain: contacts +[Context Analysis Agent] No resolved issues found for domain: contacts +[Context Analysis Agent] Found 0 similar past issues +[Context Analysis Agent] Extracted 0 reusable patterns +[Context Analysis Agent] Found 0 relevant design decisions +[Context Analysis Agent] Generated 3 recommendations + +=== GENERATE PLAN NODE === +[Research Supervisor] Generating orchestration plan... +[Research Supervisor] Plan generated successfully + +======================================== +RESEARCH SUPERVISOR - Research Phase Complete +======================================== +Final Phase: complete +Errors: 0 +======================================== + + +╔════════════════════════════════════════════════════════════════╗ +║ RESEARCH RESULTS ║ +╚════════════════════════════════════════════════════════════════╝ + +⏱️ Duration: 31.64 seconds +📊 Phase: complete +❌ Errors: 0 + +📚 DOCUMENTATION SEARCH RESULTS +────────────────────────────────────────────────────────────────────── +Source: kapa-ai +Confidence: 85% + +Documentation References (29): + +1. Core.ts#L210 + URL: https://github.com/medic/cht-core/blob/4d3c72f61a17d761f76bf6efbef3d13bf619f491/shared-libs/cht-datasource/src/libs/core.ts#L210 + Topics: contacts + +2. Constants.ts#L5 + URL: https://github.com/medic/cht-core/blob/4d3c72f61a17d761f76bf6efbef3d13bf619f491/shared-libs/cht-datasource/src/libs/constants.ts#L5 + Topics: contacts + +3. Index.ts#L119 + URL: https://github.com/medic/cht-core/blob/4d3c72f61a17d761f76bf6efbef3d13bf619f491/shared-libs/cht-datasource/src/index.ts#L119 + Topics: contacts + +4. Freetext query.js#L38 + URL: https://github.com/medic/cht-core/blob/4d3c72f61a17d761f76bf6efbef3d13bf619f491/shared-libs/search/src/freetext-query.js#L38 + Topics: contacts + +5. Nouveau.html + URL: https://docs.couchdb.org/en/stable/ddocs/nouveau.html + Topics: contacts + +6. Search.js#L97 + URL: https://github.com/medic/cht-core/blob/fbf0a0cca4c6eab1471f46a6dea3c6e5ec535f70/shared-libs/search/src/search.js#L97 + Topics: contacts + +7. 10621 + URL: https://github.com/medic/cht-core/issues/10621 + Topics: contacts + +8. Doc.ts#L176 + URL: https://github.com/medic/cht-core/blob/4d3c72f61a17d761f76bf6efbef3d13bf619f491/shared-libs/cht-datasource/src/local/libs/doc.ts#L176 + Topics: contacts + +9. 10622 + URL: https://github.com/medic/cht-core/pull/10622 + Topics: contacts + +10. Doc.ts#L233 + URL: https://github.com/medic/cht-core/blob/8d20a3987f975367e710ee3cce4b8f9b92e17b71/shared-libs/cht-datasource/src/local/libs/doc.ts#L233 + Topics: contacts + +11. 63887612 724d 4fbe a827 ee7202b39e87 + URL: https://github.com/user-attachments/assets/63887612-724d-4fbe-a827-ee7202b39e87 + Topics: contacts + +12. 9586 + URL: https://github.com/medic/cht-core/issues/9586 + Topics: contacts + +13. 9541 + URL: https://github.com/medic/cht-core/pull/9541 + Topics: contacts + +14. 9751 + URL: https://github.com/medic/cht-core/issues/9751 + Topics: contacts + +15. Search reports.wdio spec.js + URL: https://github.com/medic/cht-core/blob/9542_freetext_tco/tests/e2e/default/reports/search-reports.wdio-spec.js + Topics: contacts + +16. Search contacts.wdio spec.js + URL: https://github.com/medic/cht-core/blob/9542_freetext_tco/tests/e2e/default/contacts/search-contacts.wdio-spec.js + Topics: contacts + +17. Pagination.html + URL: http://docs.couchdb.org/en/latest/ddocs/views/pagination.html + Topics: contacts + +18. 4206 + URL: https://github.com/medic/medic/issues/4206 + Topics: contacts + +19. 4649 + URL: https://github.com/lodash/lodash/issues/4649 + Topics: contacts + +20. Search.js#L1 L111 + URL: https://github.com/medic/cht-core/blob/master/shared-libs/search/src/search.js#L1-L111 + Topics: contacts + +21. 1234 + URL: https://github.com/medic/cht-core/pull/1234 + Topics: contacts + +22. 5678 + URL: https://github.com/medic/cht-core/issues/5678 + Topics: contacts + +23. Contact page + URL: https://docs.communityhealthtoolkit.org/apps/reference/contact-page/ + Topics: contacts + +24. Contact search feature.md + URL: https://github.com/medic/cht-agent/blob/main/tickets/contact-search-feature.md + Topics: contacts + +25. Using windows + URL: https://docs.communityhealthtoolkit.org/community/contributing/code/core/using-windows/ + Topics: contacts + +26. #couchdb + URL: https://docs.communityhealthtoolkit.org/community/contributing/code/core/dev-environment/#couchdb + Topics: contacts + +27. 10625. + URL: https://github.com/medic/cht-core/issues/10625. + Topics: contacts + +28. 10625 + URL: https://github.com/medic/cht-core/issues/10625 + Topics: contacts + +29. 10913 + URL: https://github.com/medic/cht-core/issues/10913 + Topics: contacts + +Suggested Approaches: + 1. Debug using CHT debugging guidelines and common issue patterns + +🔎 CONTEXT ANALYSIS RESULTS +────────────────────────────────────────────────────────────────────── +Similar Past Issues: 0 +Reusable Patterns: 0 +Design Decisions: 0 +Historical Success Rate: 50% + +Recommendations: + 1. Add regression tests to prevent recurrence + 2. Check for similar issues in related components + 3. Validate changes with integration tests before deployment + +📋 ORCHESTRATION PLAN +────────────────────────────────────────────────────────────────────── +Estimated Complexity: HIGH +Estimated Effort: 1 week + +Proposed Approach: + Debug using CHT debugging guidelines and common issue patterns + +Key Findings: + 1. 29 documentation references found + 2. 0 similar past implementations identified + 3. Historical success rate: 50% + 4. Add regression tests to prevent recurrence + 5. Check for similar issues in related components + +Implementation Phases (4): + + 1. Setup and Configuration [low] + Set up development environment and review documentation + Components: development environment, documentation + + 2. Core Implementation [high] + Implement Freetext search causes excessive requests when getting a large number of results + Components: shared-libs/cht-datasource, shared-libs/search, api/v1/contact/uuid, Nouveau search index integration, DEFAULT_IDS_PAGE_LIMIT, DEFAULT_DOCS_PAGE_LIMIT, getPagedGenerator + Dependencies: Setup and Configuration + + 3. Testing [medium] + Write and run unit, integration, and e2e tests + Components: test suite, test data + Dependencies: Core Implementation + + 4. Documentation [low] + Update documentation and configuration examples + Components: docs, examples + Dependencies: Testing + +⚠️ Risk Factors: + 1. No similar past implementations found - breaking new ground + 2. Multiple constraints to satisfy: Must maintain compatibility with Nouveau's default limit of 25 (paging is still required, just with a larger batch size), The `fetchAndFilter` logic is not involved in the Nouveau search flow and should not be modified, Must work for both online and offline users, Affects versions 5.0.0 and 5.0.1 + 3. High priority issue - requires careful attention and thorough testing + 4. Changes span multiple components - requires coordination and integration testing + +╔════════════════════════════════════════════════════════════════╗ +║ Research Phase Complete! ✅ ║ +╚════════════════════════════════════════════════════════════════╝ + +💡 Next Steps: + 1. Review the orchestration plan + 2. Validate research findings + 3. Proceed to Development Phase (coming soon) diff --git a/docs/testing/research-workflow-test-report-10644.md b/docs/testing/research-workflow-test-report-10644.md new file mode 100644 index 0000000..0e58c3b --- /dev/null +++ b/docs/testing/research-workflow-test-report-10644.md @@ -0,0 +1,242 @@ +npm run research tickets/10644.md + +> cht-agent@0.1.0 research +> node dist/cli/research.js tickets/10644.md + +╔════════════════════════════════════════════════════════════════╗ +║ CHT Multi-Agent System - Research CLI ║ +╚════════════════════════════════════════════════════════════════╝ + +📄 Loading ticket from: /Users/andra/Documents/GitHub/cht-agent/tickets/10644.md + +✅ Ticket parsed successfully! + +🤖 Initializing Research Supervisor... + +📋 Issue Details: +━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ +Title: Add telemetry to measure task filtering +Type: enhancement +Priority: medium +Domain: tasks-and-targets +Components: webapp/src/ts/modules/tasks, CHT telemetry system, Task filtering feature, Existing telemetry implementations in CHT (pattern to follow) +━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + +🔍 Running Research Phase... + + +======================================== +RESEARCH SUPERVISOR - Starting Research Phase +======================================== +Issue: Add telemetry to measure task filtering +Domain: tasks-and-targets +Components: webapp/src/ts/modules/tasks, CHT telemetry system, Task filtering feature, Existing telemetry implementations in CHT (pattern to follow) +======================================== + + +=== DOCUMENTATION SEARCH NODE === + +[Documentation Search Agent] Starting documentation search... +[Documentation Search Agent] Domain: tasks-and-targets +[Documentation Search Agent] Issue: Add telemetry to measure task filtering +[Documentation Search Agent] Search query: tasks-and-targets webapp/src/ts/modules/tasks CHT telemetry system Task filtering feature Existing telemetry implementations in CHT (pattern to follow) Add telemetry to measure task filtering # Description + +Task filtering was recently added to CHT. To understand how this feature is being used and measure its impact, telemetry should be added to track usage of task filters. This will help i +[Documentation Search Agent] Found 26 documentation references +[Documentation Search Agent] Confidence: 0.85 + +=== CONTEXT ANALYSIS NODE === + +[Context Analysis Agent] Starting context analysis... +[Context Analysis Agent] Domain: tasks-and-targets +[Context Analysis Agent] No resolved issues found for domain: tasks-and-targets +[Context Analysis Agent] Found 0 similar past issues +[Context Analysis Agent] Extracted 0 reusable patterns +[Context Analysis Agent] Found 0 relevant design decisions +[Context Analysis Agent] Generated 0 recommendations + +=== GENERATE PLAN NODE === +[Research Supervisor] Generating orchestration plan... +[Research Supervisor] Plan generated successfully + +======================================== +RESEARCH SUPERVISOR - Research Phase Complete +======================================== +Final Phase: complete +Errors: 0 +======================================== + + +╔════════════════════════════════════════════════════════════════╗ +║ RESEARCH RESULTS ║ +╚════════════════════════════════════════════════════════════════╝ + +⏱️ Duration: 31.26 seconds +📊 Phase: complete +❌ Errors: 0 + +📚 DOCUMENTATION SEARCH RESULTS +────────────────────────────────────────────────────────────────────── +Source: kapa-ai +Confidence: 85% + +Documentation References (26): + +1. 4808 + URL: https://forum.communityhealthtoolkit.org/t/filter-option-for-task/4808 + Topics: tasks-and-targets + +2. #tasksjs + URL: https://docs.communityhealthtoolkit.org/building/tasks/tasks-js/#tasksjs + Topics: tasks-and-targets + +3. E8cdfd90 9d6f 4971 b1eb a426edcd2f32 + URL: https://github.com/user-attachments/assets/e8cdfd90-9d6f-4971-b1eb-a426edcd2f32 + Topics: tasks-and-targets + +4. 10577 + URL: https://github.com/medic/cht-core/issues/10577 + Topics: tasks-and-targets + +5. 5_1_0_task_filters.png + URL: https://docs.communityhealthtoolkit.org/releases/images/5_1_0_task_filters.png + Topics: tasks-and-targets + +6. #demo video 4 + URL: https://docs.communityhealthtoolkit.org/releases/5_1_0/#demo-video-4 + Topics: tasks-and-targets + +7. #task filtering gui + URL: https://docs.communityhealthtoolkit.org/releases/5_1_0/#task-filtering-gui + Topics: tasks-and-targets + +8. 10755 + URL: https://github.com/medic/cht-core/pull/10755 + Topics: tasks-and-targets + +9. 10438 + URL: https://github.com/medic/cht-core/issues/10438 + Topics: tasks-and-targets + +10. 10371 + URL: https://github.com/medic/cht-core/pull/10371 + Topics: tasks-and-targets + +11. 10332 + URL: https://github.com/medic/cht-core/issues/10332 + Topics: tasks-and-targets + +12. #android app launcher + URL: https://docs.communityhealthtoolkit.org/building/forms/app/#android-app-launcher + Topics: tasks-and-targets + +13. Telemetry + URL: https://docs.communityhealthtoolkit.org/technical-overview/data/performance/telemetry/ + Topics: tasks-and-targets + +14. Android app launcher.service.ts + URL: https://github.com/medic/cht-core/blob/master/webapp/src/ts/services/android-app-launcher.service.ts + Topics: tasks-and-targets + +15. Form.service.ts + URL: https://github.com/medic/cht-core/blob/master/webapp/src/ts/services/form.service.ts + Topics: tasks-and-targets + +16. Performance.service.ts + URL: https://github.com/medic/cht-core/blob/master/webapp/src/ts/services/performance.service.ts + Topics: tasks-and-targets + +17. Android app launcher.service.ts#L31 + URL: https://github.com/medic/cht-core/blob/b2f81083316600fdfda7e041ab2a8d80d07192ec/webapp/src/ts/services/android-app-launcher.service.ts#L31 + Topics: tasks-and-targets + +18. Android app launcher.service.ts#L18 + URL: https://github.com/medic/cht-core/blob/b2f81083316600fdfda7e041ab2a8d80d07192ec/webapp/src/ts/services/android-app-launcher.service.ts#L18 + Topics: tasks-and-targets + +19. 8d201a09d07d339b3addba512c629a0a57e04dab + URL: https://github.com/medic/cht-android/pull/398/commits/8d201a09d07d339b3addba512c629a0a57e04dab + Topics: tasks-and-targets + +20. 10217 + URL: https://github.com/medic/cht-core/issues/10217 + Topics: tasks-and-targets + +21. #replication + URL: https://docs.communityhealthtoolkit.org/hosting/monitoring/dashboards/#replication + Topics: tasks-and-targets + +22. Querying_apdex_telemetry + URL: https://docs.communityhealthtoolkit.org/technical-overview/data/analytics/querying_apdex_telemetry/ + Topics: tasks-and-targets + +23. Data flows for analytics + URL: https://docs.communityhealthtoolkit.org/technical-overview/data/analytics/data-flows-for-analytics/ + Topics: tasks-and-targets + +24. 2166 + URL: https://github.com/medic/cht-docs/pull/2166 + Topics: tasks-and-targets + +25. 10728 + URL: https://github.com/medic/cht-core/pull/10728 + Topics: tasks-and-targets + +26. Telemetry.service.ts#L130 L272 + URL: https://github.com/medic/cht-core/blob/master/webapp/src/ts/services/telemetry.service.ts#L130-L272 + Topics: tasks-and-targets + +🔎 CONTEXT ANALYSIS RESULTS +────────────────────────────────────────────────────────────────────── +Similar Past Issues: 0 +Reusable Patterns: 0 +Design Decisions: 0 +Historical Success Rate: 50% + +📋 ORCHESTRATION PLAN +────────────────────────────────────────────────────────────────────── +Estimated Complexity: HIGH +Estimated Effort: 1 week + +Proposed Approach: + Follow CHT best practices + +Key Findings: + 1. 26 documentation references found + 2. 0 similar past implementations identified + 3. Historical success rate: 50% + +Implementation Phases (4): + + 1. Setup and Configuration [low] + Set up development environment and review documentation + Components: development environment, documentation + + 2. Core Implementation [high] + Implement Add telemetry to measure task filtering + Components: webapp/src/ts/modules/tasks, CHT telemetry system, Task filtering feature, Existing telemetry implementations in CHT (pattern to follow) + Dependencies: Setup and Configuration + + 3. Testing [medium] + Write and run unit, integration, and e2e tests + Components: test suite, test data + Dependencies: Core Implementation + + 4. Documentation [low] + Update documentation and configuration examples + Components: docs, examples + Dependencies: Testing + +⚠️ Risk Factors: + 1. No similar past implementations found - breaking new ground + 2. Multiple constraints to satisfy: Must follow existing CHT telemetry conventions and patterns, Telemetry must work for both online and offline users, Must not degrade the user experience or add noticeable latency to filter interactions + 3. Changes span multiple components - requires coordination and integration testing + +╔════════════════════════════════════════════════════════════════╗ +║ Research Phase Complete! ✅ ║ +╚════════════════════════════════════════════════════════════════╝ + +💡 Next Steps: + 1. Review the orchestration plan + 2. Validate research findings + 3. Proceed to Development Phase (coming soon) diff --git a/docs/testing/research-workflow-test-report-2147.md b/docs/testing/research-workflow-test-report-2147.md new file mode 100644 index 0000000..36b515a --- /dev/null +++ b/docs/testing/research-workflow-test-report-2147.md @@ -0,0 +1,238 @@ +npm run research tickets/2147.md + +> cht-agent@0.1.0 research +> node dist/cli/research.js tickets/2147.md + +╔════════════════════════════════════════════════════════════════╗ +║ CHT Multi-Agent System - Research CLI ║ +╚════════════════════════════════════════════════════════════════╝ + +📄 Loading ticket from: /Users/andra/Documents/GitHub/cht-agent/tickets/2147.md + +✅ Ticket parsed successfully! + +🤖 Initializing Research Supervisor... + +📋 Issue Details: +━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ +Title: Document new REST APIs and CHT datasource functions for contact and report mutations +Type: documentation +Priority: medium +Domain: configuration +Components: shared-libs/cht-datasource, CHT docs site (REST API section), CHT datasource generated documentation site, Existing read/fetch APIs for contacts and reports (pattern to follow), Existing JSDoc in `shared-libs/cht-datasource`, Existing REST API documentation on the docs site +━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + +🔍 Running Research Phase... + + +======================================== +RESEARCH SUPERVISOR - Starting Research Phase +======================================== +Issue: Document new REST APIs and CHT datasource functions for contact and report mutations +Domain: configuration +Components: shared-libs/cht-datasource, CHT docs site (REST API section), CHT datasource generated documentation site, Existing read/fetch APIs for contacts and reports (pattern to follow), Existing JSDoc in `shared-libs/cht-datasource`, Existing REST API documentation on the docs site +======================================== + + +=== DOCUMENTATION SEARCH NODE === + +[Documentation Search Agent] Starting documentation search... +[Documentation Search Agent] Domain: configuration +[Documentation Search Agent] Issue: Document new REST APIs and CHT datasource functions for contact and report mutations +[Documentation Search Agent] Search query: configuration shared-libs/cht-datasource CHT docs site (REST API section) CHT datasource generated documentation site Existing read/fetch APIs for contacts and reports (pattern to follow) Existing JSDoc in `shared-libs/cht-datasource` Existing REST API documentation on the docs site Document new REST APIs and CHT datasource functions for contact and report mutations # Description + +Six new REST APIs and six corresponding CHT datasource functions have been added to CHT to support creating and updating contacts (people and places) and reports. Previously, `cht-datas +[Documentation Search Agent] Found 25 documentation references +[Documentation Search Agent] Confidence: 0.85 + +=== CONTEXT ANALYSIS NODE === + +[Context Analysis Agent] Starting context analysis... +[Context Analysis Agent] Domain: configuration +[Context Analysis Agent] No resolved issues found for domain: configuration +[Context Analysis Agent] Found 0 similar past issues +[Context Analysis Agent] Extracted 0 reusable patterns +[Context Analysis Agent] Found 0 relevant design decisions +[Context Analysis Agent] Generated 0 recommendations + +=== GENERATE PLAN NODE === +[Research Supervisor] Generating orchestration plan... +[Research Supervisor] Plan generated successfully + +======================================== +RESEARCH SUPERVISOR - Research Phase Complete +======================================== +Final Phase: complete +Errors: 0 +======================================== + + +╔════════════════════════════════════════════════════════════════╗ +║ RESEARCH RESULTS ║ +╚════════════════════════════════════════════════════════════════╝ + +⏱️ Duration: 31.87 seconds +📊 Phase: complete +❌ Errors: 0 + +📚 DOCUMENTATION SEARCH RESULTS +────────────────────────────────────────────────────────────────────── +Source: kapa-ai +Confidence: 85% + +Documentation References (25): + +1. Api + URL: https://docs.communityhealthtoolkit.org/building/reference/api/ + Topics: configuration + +2. Cht core + URL: https://github.com/medic/cht-core + Topics: configuration + +3. Controllers + URL: https://github.com/medic/cht-core/tree/master/api/src/controllers + Topics: configuration + +4. Person.js#L15 + URL: https://github.com/medic/cht-core/blob/f8fe649aa5fb1601a504c764942f262412dc4538/api/src/controllers/person.js#L15 + Topics: configuration + +5. Openapi extensions + URL: https://swagger.io/docs/specification/openapi-extensions/ + Topics: configuration + +6. Openapi docs + URL: https://docs.communityhealthtoolkit.org/community/contributing/code/core/openapi-docs/ + Topics: configuration + +7. V1ContactIdGet + URL: https://docs.communityhealthtoolkit.org/building/reference/api/#/Contact/v1ContactIdGet + Topics: configuration + +8. V1ContactUuidGet + URL: https://docs.communityhealthtoolkit.org/building/reference/api/#/Contact/v1ContactUuidGet + Topics: configuration + +9. V1ReportIdGet + URL: https://docs.communityhealthtoolkit.org/building/reference/api/#/Report/v1ReportIdGet + Topics: configuration + +10. V1ReportUuidGet + URL: https://docs.communityhealthtoolkit.org/building/reference/api/#/Report/v1ReportUuidGet + Topics: configuration + +11. 9586 + URL: https://github.com/medic/cht-core/issues/9586 + Topics: configuration + +12. #rest endpoints for getting contacts and reports + URL: https://docs.communityhealthtoolkit.org/releases/4_18_0/#rest-endpoints-for-getting-contacts-and-reports + Topics: configuration + +13. Pouchdb.com + URL: https://pouchdb.com/ + Topics: configuration + +14. Lineage + URL: https://github.com/medic/cht-core/tree/master/shared-libs/lineage + Topics: configuration + +15. Cht datasource + URL: https://github.com/medic/cht-core/tree/master/shared-libs/cht-datasource + Topics: configuration + +16. Edit?tab=t.0 + URL: https://docs.google.com/document/d/1EdAm_G2m_99IOLhUWamYzDMD73wWGiktNSZDcif2B04/edit?tab=t.0 + Topics: configuration + +17. 9838 + URL: https://github.com/medic/cht-core/issues/9838 + Topics: configuration + +18. #ways to contribute + URL: https://docs.communityhealthtoolkit.org/contribute/code/#ways-to-contribute + Topics: configuration + +19. Forum.communityhealthtoolkit.org + URL: https://forum.communityhealthtoolkit.org/ + Topics: configuration + +20. Contact.ts + URL: https://github.com/medic/cht-core/blob/master/shared-libs/cht-datasource/src/contact.ts + Topics: configuration + +21. README.md + URL: https://github.com/medic/cht-core/blob/master/shared-libs/cht-datasource/README.md + Topics: configuration + +22. Report.spec.js#L514 + URL: https://github.com/medic/cht-core/blob/master/tests/integration/shared-libs/cht-datasource/report.spec.js#L514 + Topics: configuration + +23. Report.spec.js#L515 + URL: https://github.com/medic/cht-core/blob/master/tests/integration/shared-libs/cht-datasource/report.spec.js#L515 + Topics: configuration + +24. Report.spec.js#L1 L18 + URL: https://github.com/medic/cht-core/blob/master/tests/integration/shared-libs/cht-datasource/report.spec.js#L1-L18 + Topics: configuration + +25. Report.spec.js#L19 L138 + URL: https://github.com/medic/cht-core/blob/master/tests/integration/shared-libs/cht-datasource/report.spec.js#L19-L138 + Topics: configuration + +🔎 CONTEXT ANALYSIS RESULTS +────────────────────────────────────────────────────────────────────── +Similar Past Issues: 0 +Reusable Patterns: 0 +Design Decisions: 0 +Historical Success Rate: 50% + +📋 ORCHESTRATION PLAN +────────────────────────────────────────────────────────────────────── +Estimated Complexity: HIGH +Estimated Effort: 1 week + +Proposed Approach: + Follow CHT best practices + +Key Findings: + 1. 25 documentation references found + 2. 0 similar past implementations identified + 3. Historical success rate: 50% + +Implementation Phases (4): + + 1. Setup and Configuration [low] + Set up development environment and review documentation + Components: development environment, documentation + + 2. Core Implementation [high] + Implement Document new REST APIs and CHT datasource functions for contact and report mutations + Components: shared-libs/cht-datasource, CHT docs site (REST API section), CHT datasource generated documentation site, Existing read/fetch APIs for contacts and reports (pattern to follow), Existing JSDoc in `shared-libs/cht-datasource`, Existing REST API documentation on the docs site + Dependencies: Setup and Configuration + + 3. Testing [medium] + Write and run unit, integration, and e2e tests + Components: test suite, test data + Dependencies: Core Implementation + + 4. Documentation [low] + Update documentation and configuration examples + Components: docs, examples + Dependencies: Testing + +⚠️ Risk Factors: + 1. No similar past implementations found - breaking new ground + 2. Multiple constraints to satisfy: REST API documentation must follow the existing format and conventions on the docs site (consistent with existing read/fetch API docs), CHT datasource documentation must use JSDoc and conform to the existing documentation patterns in `shared-libs/cht-datasource`, Changes to the docs site should go through the standard docs review process, Documentation should be consistent with the existing read API docs for contacts and reports + 3. Changes span multiple components - requires coordination and integration testing + +╔════════════════════════════════════════════════════════════════╗ +║ Research Phase Complete! ✅ ║ +╚════════════════════════════════════════════════════════════════╝ + +💡 Next Steps: + 1. Review the orchestration plan + 2. Validate research findings + 3. Proceed to Development Phase (coming soon) diff --git a/docs/ticket-validation.md b/docs/ticket-validation.md index 4b9e918..14bdc8b 100644 --- a/docs/ticket-validation.md +++ b/docs/ticket-validation.md @@ -55,7 +55,7 @@ if (result.valid) { All tickets must include these fields in the YAML frontmatter: - `title`: Brief description of the issue -- `type`: One of 'feature', 'bug', 'improvement' +- `type`: One of 'feature', 'bug', 'improvement', 'documentation' - `priority`: One of 'high', 'medium', 'low' - `domain`: One of the valid CHT domains diff --git a/src/utils/ticket-parser.ts b/src/utils/ticket-parser.ts index f341576..8d2bf5d 100644 --- a/src/utils/ticket-parser.ts +++ b/src/utils/ticket-parser.ts @@ -57,7 +57,7 @@ const extractFrontmatter = (content: string): { return { metadata, markdown }; }; -const VALID_TYPES: IssueType[] = ['feature', 'bug', 'improvement']; +const VALID_TYPES: IssueType[] = ['feature', 'bug', 'improvement', 'documentation']; const VALID_PRIORITIES: Priority[] = ['high', 'medium', 'low']; const VALID_DOMAINS: CHTDomain[] = [ 'authentication', @@ -155,7 +155,7 @@ const validateMetadata = (metadata: Record) => { throw new Error('Ticket must have a "title" in frontmatter'); } if (!metadata.type) { - throw new Error('Ticket must have a "type" in frontmatter (feature|bug|improvement)'); + throw new Error('Ticket must have a "type" in frontmatter (feature|bug|improvement|documentation)'); } if (!metadata.priority) { throw new Error('Ticket must have a "priority" in frontmatter (high|medium|low)'); @@ -238,10 +238,10 @@ const mapErrorMessage = (error: unknown): string => { const errorPatterns: [RegExp, string][] = [ [/Ticket must have a "title" in frontmatter/, 'Title is required in the YAML frontmatter'], - [/Ticket must have a "type" in frontmatter/, 'Type is required in the YAML frontmatter (feature, bug, or improvement)'], + [/Ticket must have a "type" in frontmatter/, 'Type is required in the YAML frontmatter (feature, bug, documentation or improvement)'], [/Ticket must have a "priority" in frontmatter/, 'Priority is required in the YAML frontmatter (high, medium, or low)'], [/Ticket must have a "domain" in frontmatter/, 'Domain is required in the YAML frontmatter'], - [/Invalid type:/, 'Type must be one of: feature, bug, improvement'], + [/Invalid type:/, 'Type must be one of: feature, bug, improvement, documentation'], [/Invalid priority:/, 'Priority must be one of: high, medium, low'], [/Invalid domain:/, `Domain must be one of: ${VALID_DOMAINS.join(', ')}`], [/Ticket file not found:/, 'Ticket file not found'], diff --git a/tickets/10577.md b/tickets/10577.md new file mode 100644 index 0000000..3b8050f --- /dev/null +++ b/tickets/10577.md @@ -0,0 +1,54 @@ +--- +title: Add ability to filter tasks +type: feature +priority: high +domain: tasks-and-targets +--- + +# Description + +When CHWs provide services in the community, they face challenges navigating the CHT tasks. With numerous tasks listed, it often becomes difficult to scroll through and identify specific follow-up tasks for each use case. + +To improve efficiency, the community suggested adding a filter option (similar to the reporting feature) that lets CHWs select a specific form/use case and view only the relevant tasks they need to complete. + +## Requirements + +- Provide the ability to filter tasks by high priority and/or form/use case +- Support filtering by due/overdue status as a simple toggle; when enabled, only display tasks that are due today or overdue (task labels remain the same) +- Support filtering by task type (either by `task.action.form` or by `task.name`, to be decided — note that a task can have [multiple actions](https://docs.communityhealthtoolkit.org/building/tasks/tasks-js/#tasksjs)) +- Support filtering by place, akin to report filtering by place; leaf-type places (e.g., the default config `clinic` type) should not appear in this filter + +## Acceptance Criteria + +- CHWs can toggle a due/overdue filter to see only tasks due today or overdue +- CHWs can filter the task list by task type +- CHWs can filter the task list by place, consistent with how place filtering works in the reports tab +- Leaf-type places are excluded from the place filter +- Filters can be combined to narrow down the task list +- Task labels remain unchanged when filters are applied + +## Constraints + +- Filter UX should be consistent with the existing reporting filter feature +- Must work offline +- Decision needed on whether task type filtering uses `task.action.form` or `task.name` (low-consequence decision) +- Tasks with multiple actions must be handled correctly when filtering by task type + +## Technical Context + +**Components:** +- `webapp/src/ts/modules/tasks` +- `webapp/src/ts/components/filters` + +**Existing References:** +- Report filtering feature (existing pattern to follow) +- `task.action.form` field +- `task.name` field + +## References + +**Similar Implementations:** +- https://github.com/medic/cht-core/issues/10577 + +**Documentation:** +- https://docs.communityhealthtoolkit.org/building/tasks/ diff --git a/tickets/10621.md b/tickets/10621.md new file mode 100644 index 0000000..68b6bde --- /dev/null +++ b/tickets/10621.md @@ -0,0 +1,53 @@ +--- +title: Freetext search causes excessive requests when getting a large number of results +type: bug +priority: high +domain: contacts +--- + +# Description + +Simple freetext search retrieves all results for the search in small batches of 100 instead of using the intended larger page size, causing excessive round-trip requests to the server. This was introduced in 5.0.0 when the search backend moved to Nouveau. The `cht-datasource` paged generator code was left with a hard-coded limit of 100 (the default for document fetching) instead of using the 10,000 limit intended for UUID paging. As a result, a search yielding 28,000 results triggers approximately 280 individual requests rather than just 3. + +This affects both online and offline users, though offline users are less impacted due to fewer total search results and no network latency for round-trips to PouchDB. The issue applies to both contact and report freetext searches. + +## Requirements + +- Update the `getPagedGenerator` logic to not explicitly set the limit value, allowing it to fall back to the default limit defined for the fetch function +- Ensure freetext search uses `DEFAULT_IDS_PAGE_LIMIT` (10,000) instead of `DEFAULT_DOCS_PAGE_LIMIT` (100) when paging through UUIDs +- Fix applies to both contact and report freetext searches + +## Acceptance Criteria + +- A freetext search yielding a large number of results (e.g., 10,000+) makes a small number of batched requests (e.g., 1-2 requests per 10,000 UUIDs) instead of one request per 100 UUIDs +- Search results load significantly faster on large instances +- Scrolling to the next results page does not re-fetch all results +- Both contact and report freetext searches are fixed +- Offline users are not negatively affected by the change + +## Constraints + +- Must maintain compatibility with Nouveau's default limit of 25 (paging is still required, just with a larger batch size) +- The `fetchAndFilter` logic is not involved in the Nouveau search flow and should not be modified +- Must work for both online and offline users +- Affects versions 5.0.0 and 5.0.1 + +## Technical Context + +**Components:** +- `shared-libs/cht-datasource` (paged generator logic) +- `shared-libs/search` (freetext search flow) +- `api/v1/contact/uuid` endpoint +- Nouveau search index integration + +**Existing References:** +- `DEFAULT_IDS_PAGE_LIMIT` (10,000) — intended page size for UUID fetching +- `DEFAULT_DOCS_PAGE_LIMIT` (100) — page size for document fetching (incorrectly used) +- `getPagedGenerator` function — where the limit override occurs + +## References + +**Similar Implementations:** +- https://github.com/medic/cht-core/issues/10621 +- https://github.com/medic/cht-core/pull/10622 +- https://github.com/medic/cht-core/issues/10625 diff --git a/tickets/10644.md b/tickets/10644.md new file mode 100644 index 0000000..3e94613 --- /dev/null +++ b/tickets/10644.md @@ -0,0 +1,44 @@ +--- +title: Add telemetry to measure task filtering +type: enhancement +priority: medium +domain: tasks-and-targets +--- + +# Description + +Task filtering was recently added to CHT. To understand how this feature is being used and measure its impact, telemetry should be added to track usage of task filters. This will help inform future decisions about the feature and identify areas for improvement. + +## Requirements + +- Add telemetry events to track when task filters are applied +- Capture which filter types are being used (due/overdue, task type, place) +- Measure frequency of filter usage across users + +## Acceptance Criteria + +- Telemetry data is recorded when a user applies, changes, or clears a task filter +- Telemetry distinguishes between the different filter types (due/overdue, task type, place) +- Telemetry data is accessible through the existing telemetry pipeline +- No negative impact on task filtering performance + +## Constraints + +- Must follow existing CHT telemetry conventions and patterns +- Telemetry must work for both online and offline users +- Must not degrade the user experience or add noticeable latency to filter interactions + +## Technical Context + +**Components:** +- `webapp/src/ts/modules/tasks` +- CHT telemetry system + +**Existing References:** +- Task filtering feature +- Existing telemetry implementations in CHT (pattern to follow) + +## References + +**Similar Implementations:** +- https://github.com/medic/cht-core/issues/10644 diff --git a/tickets/2147.md b/tickets/2147.md new file mode 100644 index 0000000..c335c72 --- /dev/null +++ b/tickets/2147.md @@ -0,0 +1,62 @@ +--- +title: Document new REST APIs and CHT datasource functions for contact and report mutations +type: documentation +priority: medium +domain: configuration +--- + +# Description + +Six new REST APIs and six corresponding CHT datasource functions have been added to CHT to support creating and updating contacts (people and places) and reports. Previously, `cht-datasource` only supported reading/fetching contacts and reports — these new APIs introduce write (create/update) capabilities. + +The REST API documentation needs to be added to the CHT docs site. The CHT datasource is documented using JSDoc and has its own dedicated documentation site which is linked from the docs site. Most of the CHT datasource documentation has already been completed, but a review is needed to ensure nothing has been missed. + +## Requirements + +- Add documentation for all 6 new REST APIs to the CHT docs site: + - Create person + - Update person + - Create place + - Update place + - Create report + - Update report +- Verify that all 6 corresponding CHT datasource functions in `shared-libs/cht-datasource` are fully documented via JSDoc +- Ensure the generated CHT datasource documentation site is up to date and correctly linked from the docs site +- Perform an audit of existing CHT datasource JSDoc to confirm no new functions, parameters, or types are undocumented + +## Acceptance Criteria + +- All 6 new REST APIs have complete documentation on the docs site, including endpoints, HTTP methods, request/response formats, authentication requirements, and example usage +- All 6 new CHT datasource functions are documented in JSDoc with descriptions, parameter types, return types, and usage examples +- The generated CHT datasource documentation site reflects all new create/update functions for people, places, and reports +- The link from the CHT docs site to the CHT datasource documentation is valid and up to date +- No undocumented public functions, parameters, or types remain after the audit +- Documentation clearly distinguishes between person and place contact types where applicable + +## Constraints + +- REST API documentation must follow the existing format and conventions on the docs site (consistent with existing read/fetch API docs) +- CHT datasource documentation must use JSDoc and conform to the existing documentation patterns in `shared-libs/cht-datasource` +- Changes to the docs site should go through the standard docs review process +- Documentation should be consistent with the existing read API docs for contacts and reports + +## Technical Context + +**Components:** +- `shared-libs/cht-datasource` +- CHT docs site (REST API section) +- CHT datasource generated documentation site + +**Existing References:** +- Existing read/fetch APIs for contacts and reports (pattern to follow) +- Existing JSDoc in `shared-libs/cht-datasource` +- Existing REST API documentation on the docs site + +## References + +**Similar Implementations:** +- https://github.com/medic/cht-docs/issues/2148 + +**Documentation:** +- https://docs.communityhealthtoolkit.org/cht-datasource/ +- https://github.com/medic/cht-core/tree/master/shared-libs/cht-datasource \ No newline at end of file diff --git a/tickets/README.md b/tickets/README.md index 9027023..e88867f 100644 --- a/tickets/README.md +++ b/tickets/README.md @@ -167,10 +167,13 @@ What needs to be done... - `feature` = new functionality - `bug` = something is broken - `improvement` = improve existing functionality (same idea as GitHub **Type: Improvement**) + - `documentation` = document a functionality + - **Priority**: - `high` = urgent or critical - `medium` = important but not urgent - `low` = nice to have + - **Domain**: Pick the area that best matches the work; see the list above. - **Description**: Explain what you need and why in plain language. - **Requirements**: List what the solution should do.