Hacktoberfest 2026: le issue che i maintainer hanno segnato per ottobre, aperte e adatte ai principianti. Sfoglia le issue Hacktoberfest

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

Chiusa
  • Qualcosa non va?
#3,809 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

I maintainer di solito rispondono entro 3 giorni

Una pull request collegata è già stata integrata.

  • #3811 di @armando-navarro — integrata

Valutazione

Difficoltà
2/5
Tempo stimato
1-3 ore
Idoneità per principianti
35/100
Tipo di issue
Funzionalità
Chiarezza
Specificata chiaramente
Stato di attività
Ferma
Stack tecnologico
angular, firebase, typescript
Ambito
build-system, release

Direzione di ricerca

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.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

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.

Lingua principale
TypeScript
Stelle
7.8k
Fork
2.2k
Merge medio
3g 36m
PR unite (30g)
24

Preparare l'ambiente

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di angular/angularfire

Tutte le issue di angular/angularfire

Issue simili

Altre issue su TypeScript

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.