okf: rename face to bundle

オープン
  • 何か問題がありますか？
#61 コメント 0 件 リアクション 0 件 担当者 0 名 GitHub で見る

まだ誰も着手していません。

評価

難易度
3/5
見積もり時間
1〜2日
初心者へのやさしさ
45/100
issue の種類
リファクタリング
明瞭さ
おおむね明確
活発さ
活発
技術スタック
javascript
領域
cli, documentation, tooling

調査の方向性

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
30日以内にマージされた PR はありません

環境構築

このプロジェクトには開発コンテナ、Dockerfile、コントリビューションガイドがありません。まず README を読み、一般的な手順ははじめてのコントリビューションガイドを参照してください。

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

indexzero/hyperdown のほかの issue

indexzero/hyperdown の issue をすべて見る

似ている issue

JavaScript の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。