Skip to content

Repositório declara MIT mas não distribui o arquivo LICENSE (+2 links de doc quebrados) #47

Description

@Abner-Machado

Levantamento feito na master (v6.0.0). São três defeitos de documentação/empacotamento, verificados contra a árvore do repositório, não contra o texto.

1. Licença declarada, arquivo ausente

docs/API.md:3093 diz:

MIT License - see [LICENSE](../LICENSE) for details

E o package.json declara "license": "MIT".

Só que não existe arquivo LICENSE no repositório. Busca na árvore inteira da master não retorna nenhum. O link em docs/API.md aponta para o nada, e o pacote nfe-io vai para o npm sem o texto da licença.

Isso é mais que um link quebrado: sem o arquivo, quem consome o SDK não tem o texto da licença junto do código, e o npm mostra a licença só como metadado. Para quem precisa passar por revisão jurídica ou varredura de dependência, isso costuma barrar.

Correção sugerida: adicionar o LICENSE MIT na raiz com a titularidade correta (NFE.io) — é decisão de vocês, por isso mandei como issue e não como PR.

2. README.md:1100 aponta para arquivo inexistente

Para orientações de migração, veja [docs/MIGRATION-TO-GENERATED-TYPES.md](./docs/MIGRATION-TO-GENERATED-TYPES.md).

docs/ tem 36 arquivos e nenhum se chama MIGRATION-TO-GENERATED-TYPES.md. O guia de migração que existe de verdade é o MIGRATION.md da raiz, que inclusive cobre a parte de tipos gerados por OpenAPI.

Já tenho a correção pronta (uma linha, aponta para ./MIGRATION.md), mas não consigo abrir PR neste repositórioPOST /repos/nfe/client-nodejs/pulls responde 404 e a API GraphQL recusa o CreatePullRequest, o que costuma indicar limite de interação ligado. O fork e o push funcionam normalmente. Se for intencional, tudo bem; se não for e vocês quiserem o PR, é só avisar que eu mando.

3. CHANGELOG.md:1171 referencia arquivo inexistente

- **Release notes:** [RELEASE_NOTES_v3.md](./RELEASE_NOTES_v3.md)

RELEASE_NOTES_v3.md também não está na árvore. Esse trecho é instrução ativa de migração v2 para v3, não entrada histórica — o leitor que seguir o link cai em 404.

Activity

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

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions