Hacktoberfest 2026:维护者为十月标记出来的 issue,仍然开放、适合新手。 浏览 Hacktoberfest issue

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

未关闭
#3,809 0 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

维护者通常 3 天内回复

@armando-navarro 已经在做这个了。

开始于 2026年10月23日。

  • #3811 来自 @armando-navarro —— 未关闭

评估

难度
2/5
预计耗时
1-3 小时
新手友好度
35/100
Issue 类型
功能
描述清晰度
描述清楚
活跃度
停滞
技术栈
angular, firebase, typescript

调研方向

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.

由索引模型根据 Issue 内容生成。

描述

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.

主要语言
TypeScript
星标
7.8k
派生
2.2k
平均合并
2 天 7 小时
30 天内合并 PR
18

环境准备

从这里开始

  1. 先读完整个 Issue,再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库,在一个分支上完成修改。
  4. 提交 Pull Request,并在描述里引用这个 Issue 编号。

angular/angularfire 的其他 Issue

查看 angular/angularfire 的全部 Issue

相似的 Issue

更多 TypeScript Issue

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。