okf: rename face to bundle

Đang mở
  • Có gì không ổn?
#61 0 bình luận 0 reaction 0 người được giao Xem trên GitHub

Chưa có ai nhận issue này.

Đánh giá

Độ khó
3/5
Thời gian dự kiến
1-2 ngày
Mức phù hợp với người mới
45/100
Loại issue
Tái cấu trúc
Độ rõ ràng
Khá rõ ràng
Mức độ hoạt động
Sôi nổi
Công nghệ
javascript
Lĩnh vực
cli, documentation, tooling

Hướng nghiên cứu

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.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Mô tả

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.

Ngôn ngữ chính
JavaScript
Star
0
Fork
0
Không có pull request nào được merge trong 30 ngày

Chuẩn bị môi trường

Dự án này không cung cấp dev container, Dockerfile hay hướng dẫn đóng góp, nên bạn cần tự thiết lập môi trường: hãy bắt đầu từ README và xem hướng dẫn đóng góp lần đầu của chúng tôi để biết các bước chung.

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Issue khác của indexzero/hyperdown

Tất cả issue của indexzero/hyperdown

Issue tương tự

Thêm issue về JavaScript

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.