Skip to content

docs: comenta a base de codigo da BFF (densidade de comentarios)#23

Merged
GenilsonJrs merged 6 commits into
mainfrom
docs/densidade-comentarios
Jun 28, 2026
Merged

docs: comenta a base de codigo da BFF (densidade de comentarios)#23
GenilsonJrs merged 6 commits into
mainfrom
docs/densidade-comentarios

Conversation

@GenilsonJrs

Copy link
Copy Markdown
Contributor

Descrição

Adiciona comentários explicativos por toda a base de código da BFF — camada de configuração, clients/utils/constantes compartilhados, errors/middlewares/types, rotas, módulos de ranking e perfil-social e o bootstrap do servidor.

O objetivo é elevar a densidade de comentários medida pelo SonarCloud, atendendo à cobertura adequada solicitada pelo professor. A mudança é somente de comentários: nenhuma linha de lógica foi adicionada, removida ou alterada.

Rastreabilidade

Issue(s) Relacionada(s):

Não se aplica — PR não vinculado a issue. Feito a pedido do professor para adequar a densidade de comentários prevista pelo SonarCloud.

Commits relacionados:

  • b80ba17 — docs: comenta a camada de configuracao
  • 8a6c219 — docs: comenta clients, utils e constantes compartilhados
  • 0665cf6 — docs: comenta errors, middlewares e types compartilhados
  • c0ba485 — docs: comenta as rotas
  • 6e7b6d6 — docs: comenta os modulos ranking e perfil-social
  • 822e856 — docs: comenta o bootstrap do servidor

Tipo de Mudança

  • Feature (nova funcionalidade)
  • Bugfix (correção de erro)
  • Refactor (melhoria interna)
  • Documentação
  • Testes

Evidências (se aplicável)

Não se aplica — mudança apenas de comentários, sem alteração visual ou funcional.

Checklist

  • Código segue o padrão de commits (Commitizen)
  • PR está vinculado a uma issue (US ou Task)
  • Testes foram adicionados/atualizados
  • Código revisado localmente
  • Não quebra funcionalidades existentes

Observações

Mudança 100% de comentários, sem tocar em lógica. Validado localmente: build (tsc), ESLint e a suíte de testes passaram — 107 testes / 16 suítes, todos verdes.

Não há testes adicionados nem issue vinculada por se tratar de tarefa de documentação feita a pedido do professor (densidade de comentários do SonarCloud).

GenilsonJrs and others added 6 commits June 27, 2026 20:43
Co-authored-by: EhOMiguel <Miguelmsoliveira@gmail.com>
Co-authored-by: EhOMiguel <Miguelmsoliveira@gmail.com>
Co-authored-by: EhOMiguel <Miguelmsoliveira@gmail.com>
Co-authored-by: EhOMiguel <Miguelmsoliveira@gmail.com>
Co-authored-by: EhOMiguel <Miguelmsoliveira@gmail.com>
Co-authored-by: EhOMiguel <Miguelmsoliveira@gmail.com>
@sonarqubecloud

Copy link
Copy Markdown

@GenilsonJrs GenilsonJrs merged commit d70f924 into main Jun 28, 2026
3 checks passed
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.

2 participants