Skip to content

docs: clarify scanner file reading behavior - #40

Merged
joaooncode merged 1 commit into
joaooncode:mainfrom
nightcityblade:fix/issue-36
Sep 11, 2026
Merged

joaooncode merged 1 commit into
joaooncode:mainfrom
nightcityblade:fix/issue-36

Conversation

@nightcityblade

Copy link
Copy Markdown
Contributor

Descrição

Atualiza a documentação de Scanner.Scan para refletir a leitura limitada feita pelo detector de secrets.

Closes #36

Tipo de Alteração

  • docs: Alteração ou adição na documentação

Alterações Realizadas

  • Documenta o limite de leitura de 1 MB.
  • Documenta que arquivos binários são ignorados.
  • Esclarece que a leitura vale para arquivos de ambiente fora da allowlist.

Como Testar

  1. Execute go test ./....
  2. Execute go build ./....

Checklist do Contribuinte (Pré-Envio)

  • Revi as minhas alterações com git diff e git status.
  • Garanti que nenhum arquivo sensível, segredo, token ou arquivo temporário foi comitado.
  • O código segue os padrões de formatação.
  • Os testes automatizados e builds estão passando localmente.
  • As mensagens de commit seguem Conventional Commits.

Breaking Changes / Observações

  • Nenhuma breaking change.
  • Observações: somente comentário de documentação.

@joaooncode
joaooncode merged commit f57cdab into joaooncode:main Sep 11, 2026
6 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.

docs: comentário de Scanner.Scan afirma que nunca lê conteúdo de arquivos, o que não é mais verdade

2 participants