okf: rename face to bundle

Aperta
#61 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
3/5
Tempo stimato
1-2 giorni
Idoneità per principianti
45/100
Tipo di issue
Refactoring
Chiarezza
Abbastanza chiara
Stato di attività
Attiva
Stack tecnologico
javascript

Direzione di ricerca

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.

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

Descrizione

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.

Lingua principale
JavaScript
Stelle
0
Fork
0
Metriche di merge delle PR
Nessuna PR unita negli ultimi 30g

Preparare l'ambiente

Questo progetto non fornisce container di sviluppo, Dockerfile né guida per i contributori, quindi l'ambiente è a tuo carico: parti dal suo README e consulta la nostra guida al primo contributo per i passaggi generali.

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 indexzero/hyperdown

Tutte le issue di indexzero/hyperdown

Issue simili

Altre issue su JavaScript

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.