Hacktoberfest 2026: as issues que os mantenedores marcaram para outubro, abertas e boas para iniciantes. Ver issues do Hacktoberfest

Stop shipping the `docs/` folder inside the `@angular/fire` npm package

Aberta
  • Algo errado?
#3,809 0 comentários 0 reações 0 responsáveis Ver no GitHub

Mantenedores costumam responder em até 2 dias

@armando-navarro já está trabalhando nisso.

Desde 23/10/2026.

  • #3811 de @armando-navarro — aberto

Avaliação

Dificuldade
2/5
Tempo estimado
1-3 horas
Facilidade para iniciantes
35/100
Tipo de issue
Funcionalidade
Clareza
Claramente especificada
Status de atividade
Estagnada
Stack de tecnologia
angular, firebase, typescript
Domínio
build-system, release

Direção de pesquisa

Read tools/build.ts and inspect the build output and package contents to confirm where docs/ is copied and that README.md remains included. The issue reports that no package code reads the copied documentation and proposes removing it from the publish output. Done means the built package excludes docs/ while preserving README.md; an open linked pull request (#3811) already addresses this work.

Escrita pelo modelo de indexação a partir do texto da issue.

Descrição

comp: build/pipeline type: chore

The published @angular/fire tarball carries the repository's whole docs/ tree. tools/build.ts has copied it into the publish output since the 6.0.0 build script (#2282), and no code in the package reads it.

What it costs

Measured on 22.0.0-canary.20261023183021.sha-f95d598:

  • 53 of the tarball's 175 files are documentation, 1,030,796 of 4,694,110 bytes unpacked.
  • Without them the compressed tarball goes from 2,021,273 to 1,173,999 bytes, a 42 percent cut.
  • The shipped copy freezes at the installed version while the GitHub pages move on.
  • The copy includes docs/firebase.json, a sample file. At least one published project points its App Hosting rootDir at node_modules/@angular/fire/docs/firebase.json, which the file's presence invited.
Proposal

Drop the docs/ copy from the build. README.md keeps shipping. The documentation stays where it is maintained, on GitHub.

I have not found anything that depends on the in-package path, and I would like to hear about it if you have.

Linguagem predominante
TypeScript
Estrelas
7.8k
Forks
2.2k
Merge médio
2d 6h
PRs com merge (30d)
16

Preparar o ambiente

Primeiros passos

  1. Leia a issue inteira e depois o guia de contribuição do projeto.
  2. Comente na issue dizendo que vai assumir — evita que duas pessoas façam o mesmo trabalho.
  3. Faça um fork do repositório e trabalhe em uma branch.
  4. Abra um pull request que referencie o número da issue.

Mais de angular/angularfire

Todas as issues de angular/angularfire

Issues semelhantes

Mais issues de TypeScript

Receba novas issues na sua caixa de entrada

Um resumo curto de issues do GitHub para quem está começando.