okf: rename face to bundle

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

还没有人认领这个 Issue。

评估

难度
3/5
预计耗时
1-2 天
新手友好度
45/100
Issue 类型
重构
描述清晰度
基本清楚
活跃度
活跃
技术栈
javascript

调研方向

Start by settling the open question in the issue: whether the @auto-okf/faces package gets renamed or keeps its name with a stated reason. Then search the repo for "face" and work through README, SPEC, SECURITY_MODEL, GLOSSARY, the package READMEs, and the CLI help text where <face-dir> becomes <bundle-dir>. Done means no "face" remains outside the out-of-scope .okf-manifest.json and .okf-encrypted names.

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

描述

okf calls the files that materialize writes a "face". The word is
jargon. A reader has to learn it before the docs make sense.

The same directory already has a plain name: "bundle". The glossary
uses it, and so does the CLI, in <bundle-dir>. But import takes a
<face-dir>. One thing, two words, half the grep.

Keep bundle. Drop face. Everywhere:

  • docs: README, SPEC, SECURITY_MODEL, GLOSSARY, the package READMEs
  • CLI help and arguments: <face-dir> becomes <bundle-dir>
  • error text and code identifiers that say face

The package @auto-okf/faces holds materialize, ingest and import.
Rename it too, or keep the name and say why. Decide before the work starts.

Out of scope: the file names .okf-manifest.json and .okf-encrypted.

主要语言
JavaScript
星标
0
派生
0
PR 合并指标
30 天内没有已合并 PR

环境准备

这个项目没有提供开发容器、Dockerfile 或贡献指南,环境需要你自己搭建:先看它的 README,通用步骤见我们的新手贡献指南。

从这里开始

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

indexzero/hyperdown 的其他 Issue

查看 indexzero/hyperdown 的全部 Issue

相似的 Issue

更多 JavaScript Issue

把新 issue 发到你的邮箱

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