Skip to content

Docs/technical debt review#106

Merged
frigini merged 5 commits intomasterfrom
docs/technical-debt-review
Jan 17, 2026
Merged

Docs/technical debt review#106
frigini merged 5 commits intomasterfrom
docs/technical-debt-review

Conversation

@frigini
Copy link
Copy Markdown
Owner

@frigini frigini commented Jan 17, 2026

Summary by CodeRabbit

  • Documentation
    • Updated roadmap: added Sprint 7.15 and 7.16, re-sequenced Sprints 8–9, reframed Sprint names to “Customer App”, and advanced MVP to Feb 17, 2026.
    • Expanded Sprint narratives with success criteria, risks, and timeline adjustments.
    • Added detailed Sprint 7.16 technical-debt plan (Keycloak automation, frontend warnings remediation, test coverage, refactors).
    • Reorganized technical-debt doc into a multi-sprint backlog and condensed prior sprint content.

✏️ Tip: You can customize this high-level summary in your review settings.

Filipe Frigini added 3 commits January 16, 2026 23:52
- Remove Sprint 7.6 (otimização de testes) - já concluído
- Remove referências a Polly.Extensions.Http - migrado para Microsoft.Extensions.Http.Resilience
- Atualiza seção Hangfire+Npgsql de CRÍTICO para MONITORAMENTO (funciona, aguarda validação produção)
- Atualiza Microsoft.OpenApi com teste realizado em 16/01/2026 - confirmado incompatível
- Remove seção ExampleSchemaFilter (já estava marcado como removido)
- Consolida refatorações Messaging e Extensions em seção única
- Mantém apenas débitos técnicos PENDENTES e melhorias futuras
- Simplifica seções mantendo apenas informações acionáveis
- Sprint 7.15: Document package updates and Polly migration
  * 39 NuGet packages updated to .NET 10.0.2
  * Microsoft.Build 17.14.28 → 18.0.2 (EF Core 10.0.2 requirement)
  * Polly.Extensions.Http → Microsoft.Extensions.Http.Resilience
  * Commits: b370b32, 949b6d3

- Sprint 8: Restructure as dual-track (Customer App + Quality)
  * Track 1: Customer App (Web + Mobile) - Priority MAXIMUM
  * Track 2: Quality Improvements (parallel, 2-3 days)
    - Frontend analyzer warnings fix (S2094, S2953, S2933, MUD0002)
    - Test coverage increase (10 → 30-40 tests bUnit)
    - Keycloak client automation script (setup-keycloak-clients.ps1)
  * Timeline: 17-31 Jan 2026 (3 weeks)

- Update executive summary Sprint 7-7.15 completed
- Adjust Sprint 9 dates (3 Fev - 14 Fev 2026)
- Update MVP target date (17 Feb 2026)
- NEW Sprint 7.16: 1 week focused on debt reduction BEFORE Customer App
- Moved all quality improvements from Sprint 8 to Sprint 7.16:
  * Keycloak client automation (BLOCKER for Customer App)
  * Frontend analyzer warnings (S2094, S2953, S2933, MUD0002)
  * Frontend test coverage (10 → 30-40 tests)
  * Records standardization
  * SearchProviders E2E tests (optional)

- Sprint 8 restructured: Pure Customer App focus (2 weeks, 22 Jan - 4 Fev)
  * No quality distractions (debt resolved in 7.16)
  * Keycloak client already configured
  * Test patterns already established

Rationale:
- Better to resolve Admin Portal debt BEFORE adding 5000+ Customer App lines
- Keycloak automation is BLOCKER (needs meajudaai-customer client)
- Quality improvements establish patterns for Customer App
- Zero distractions during Customer App development

Benefits Sprint 7.16:
- Keycloak automation: 1 command setup
- 0 warnings: Code quality maximized
- 30-40 tests: 3x confidence increase
- Records standardized: Consistency across project

Timeline updated:
- Sprint 7.16: 17-21 Jan (5 days)
- Sprint 8: 22 Jan - 4 Fev (2 weeks)
- Sprint 9: 5-14 Fev (buffer)
- MVP Launch: 17 Feb 2026
@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai bot commented Jan 17, 2026

📝 Walkthrough

Walkthrough

Adds detailed Sprint 7.15 and Sprint 7.16 entries to the roadmap (package updates, resilience migration, scheduling), and reorganizes the technical-debt doc to a Sprint 6–7 framing with reprioritized frontend analyzers, test coverage, Keycloak automation, and refactor notes. All changes are documentation only.

Changes

Cohort / File(s) Summary
Roadmap Documentation
docs/roadmap.md
Inserted Sprint 7.15 and Sprint 7.16 narratives: NuGet/package updates, migration from Polly.Extensions.Http to Microsoft.Extensions.Http.Resilience, .NET 10 compatibility notes, Sprint 7.16 technical-debt plan, updated Sprint 8/9 milestones, adjusted MVP target/timelines, and revised risk/commit notes.
Technical Debt Documentation
docs/technical-debt.md
Rewrote major sections to present a Sprint 6–7 technical-debt backlog: replaced Sprint 7.6 framing, moved/renamed sprint labels, added frontend warnings remediation, updated frontend test coverage targets (Sprint 7.16), Keycloak automation tasks, consolidated refactor proposals, and revised mitigation/monitoring guidance.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Poem

🐰 I hopped through lines of roadmap lore,
Added sprints and debt to store,
Polly bowed to resilience bright,
Keys and tests now set alight,
A tiny hop — the docs feel right!

🚥 Pre-merge checks | ✅ 2 | ❌ 1
❌ Failed checks (1 warning)
Check name Status Explanation Resolution
Description check ⚠️ Warning The pull request has no description provided by the author, despite a detailed template being available for the repository. Add a pull request description following the repository template, including Summary, Problem, Solution, Changes, Impact, Testing, Checklist, Related issues, and Notes for Reviewers sections.
✅ Passed checks (2 passed)
Check name Status Explanation
Title check ✅ Passed The title 'Docs/technical debt review' clearly summarizes the main change in the changeset, which involves updates to technical debt documentation.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.


Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 2

🤖 Fix all issues with AI agents
In `@docs/roadmap.md`:
- Around line 1071-1503: The file contains a duplicated "### ⏳ Sprint 7.16 -
Technical Debt Sprint (17-21 Jan 2026)" section; remove the second complete copy
(the later block starting with the same Sprint 7.16 header) so only the first
occurrence remains, ensuring the single header "Sprint 7.16 - Technical Debt
Sprint (17-21 Jan 2026)" and its tasks (Keycloak Client Automation, Frontend
Analyzer Warnings, Frontend Test Coverage, Records Standardization,
SearchProviders E2E Tests) are kept once and any trailing duplicate content
after that header is deleted.

In `@docs/technical-debt.md`:
- Line 15: Update the sprint labels in docs/technical-debt.md where items are
incorrectly marked "Sprint 8": replace the text "**Sprint**: Sprint 8
(planejado)" and other occurrences tied to the Frontend warnings, Frontend test
coverage, and Keycloak automation entries with "Sprint 7.16" (the Technical Debt
Sprint) to match roadmap.md; ensure all similar references (e.g., the lines
containing "Frontend warnings", "Frontend test coverage", "Keycloak automation")
are updated consistently across the document.
🧹 Nitpick comments (2)
docs/roadmap.md (1)

1099-1099: Consider using markdown link syntax for URLs.

Bare URLs on lines 1099 and 1316 could be converted to markdown links for better formatting and accessibility.

📝 Example conversion
-Monitorar: https://github.com/frankhommers/Hangfire.PostgreSql/issues
+Monitorar: [Hangfire.PostgreSql Issues](https://github.com/frankhommers/Hangfire.PostgreSql/issues)

Based on learnings: This is a minor documentation improvement, not a critical issue.

Also applies to: 1316-1316

docs/technical-debt.md (1)

187-190: Add language specifier to code fence.

The fenced code block showing the error message should have a language specifier for proper syntax highlighting and consistency.

📝 Proposed fix
-**Erro Encontrado**:
-```
-error CS0200: Property or indexer 'IOpenApiMediaType.Example' cannot be assigned to -- it is read only
-```
+**Erro Encontrado**:
+```text
+error CS0200: Property or indexer 'IOpenApiMediaType.Example' cannot be assigned to -- it is read only
+```

Fixes:
- Remove duplicate Sprint 7.16 section in roadmap.md (lines 1288-1503)
- Update Sprint 8 references to Sprint 7.16 in technical-debt.md:
  * Frontend Analyzer Warnings
  * Frontend Test Coverage
  * Keycloak Client Automation
  * Records Standardization
- Convert bare URL to markdown link (Hangfire.PostgreSql Issues)
- Add language specifier (text) to code fence in technical-debt.md

Changes: -225 lines (duplicate removal), +8 lines (corrections)
Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 2

🤖 Fix all issues with AI agents
In `@docs/roadmap.md`:
- Line 40: Update the roadmap to resolve the MVP launch date conflict by
choosing a single authoritative date and applying it consistently: locate the
entry with "🎯 **17 Fevereiro 2026**" and the "Sprint 9 Expected Results"
section that mentions "31 de Março de 2026", decide which date is correct (or a
new agreed-upon date), then replace the incorrect date occurrence(s) so both the
top-level MVP Launch line and the Sprint 9 Expected Results entry use the same
launch date and add a one-line note if the schedule was adjusted to reflect
scope/timeline changes.

In `@docs/technical-debt.md`:
- Around line 217-222: Update the "Padronização de Records" entry so the Sprint
and Severity fields are consistent with the roadmap: locate the "Padronização de
Records" section in technical-debt.md and change the metadata `**Severidade**:
BAIXA` to `**Severidade**: MÉDIA` and `**Sprint**: BACKLOG` to `**Sprint**:
Sprint 7.16 (Dia 5)` (or alternatively update the roadmap if you intend to keep
it in BACKLOG); also ensure the "Ação Sugerida" text references the same Sprint
designation (Sprint 7.16) to eliminate the contradiction between
technical-debt.md and roadmap.md.
🧹 Nitpick comments (1)
docs/roadmap.md (1)

1099-1099: Markdown style: Use proper link syntax for URLs.

Bare URLs should be formatted using markdown link syntax for better readability and consistency with documentation standards.

Suggested formats:

  • Named link: [dotnet/aspire#6789](https://github.com/dotnet/aspire/issues/6789)
  • Auto-link: <https://github.com/dotnet/aspire/issues/6789>
♻️ Proposed fix

If this is the URL on line 1099 (the context shows it's a GitHub issue link):

-- Link para issue upstream: [dotnet/aspire#6789](https://github.com/dotnet/aspire/issues/6789)
+- Link para issue upstream: <https://github.com/dotnet/aspire/issues/6789>

Or use named link format:

-- Link para issue upstream: [dotnet/aspire#6789](https://github.com/dotnet/aspire/issues/6789)
+- Link para issue upstream: [dotnet/aspire#6789](https://github.com/dotnet/aspire/issues/6789)

Apply similar fix to the duplicate occurrence in the second Sprint 7.16 section.

Fixes:
- Standardize MVP launch date to 17 Feb 2026 across all sections:
  * Updated Sprint history (line 1850): 31 March → 17 Feb
  * Updated Cronograma table (line 1885-1890): Adjusted sprint dates
  * Updated Sprint 9 results (line 4136): 31 March → 17 Feb
  * Added note explaining date change (Sprint 7 optimizations + Sprint 7.16)

- Update Records Standardization metadata in technical-debt.md:
  * Severity: BAIXA → MÉDIA (matches roadmap priority)
  * Sprint: BACKLOG → Sprint 7.16 (Dia 5, ~0.5 dia)
  * Consistent with roadmap.md Sprint 7.16 Task #4

- Update Sprint table to reflect current state:
  * Sprint 7: ✅ CONCLUÍDO
  * Sprint 7.16: ⏳ EM ANDAMENTO (1 week, 17-21 Jan)
  * Sprint 8: ⏳ Planejado (2 weeks, 22 Jan - 4 Fev)
  * Sprint 9: ⏳ Planejado (10 days, 5-14 Fev)

Rationale:
- Original 31 March date was outdated
- Sprint 7 Parts 10-15 accelerated Admin Portal completion
- Sprint 7.16 Technical Debt Sprint removes blockers
- Realistic timeline: Sprint 9 ends 14 Feb, launch 17 Feb (3 days buffer)
@frigini frigini merged commit dfe68f4 into master Jan 17, 2026
7 of 8 checks passed
@frigini frigini deleted the docs/technical-debt-review branch January 17, 2026 03:30
@github-actions
Copy link
Copy Markdown

📊 Code Coverage Report

Coverage: 90.27% (extracted from Cobertura (Aggregated Direct))

📈 Coverage Details

  • Coverage badges: Coverage
  • Minimum threshold: 80% (warning) / 90% (good)
  • Report format: Auto-detected from OpenCover/Cobertura XML files
  • Coverage source: Cobertura (Aggregated Direct)

📋 Coverage Analysis

  • Line Coverage: Shows percentage of code lines executed during tests
  • Branch Coverage: Shows percentage of code branches/conditions tested
  • Complexity: Code complexity metrics for maintainability

🎯 Quality Gates

  • Pass: Coverage ≥ 90%
  • ⚠️ Warning: Coverage 80-89%
  • Fail: Coverage < 80%

📁 Artifacts

  • Coverage reports: Available in workflow artifacts
  • Test results: TRX files with detailed test execution data

This comment is updated automatically on each push to track coverage trends.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant