okf: rename face to bundle

Abierto
#61 0 comentarios 0 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
3/5
Tiempo estimado
1-2 días
Aptitud para principiantes
45/100
Tipo de issue
Refactorización
Claridad
Bastante claro
Estado de actividad
Activo
Stack tecnológico
javascript

Línea de trabajo

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.

Escrito por el modelo de indexación a partir del texto del issue.

Descripción

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.

Lenguaje dominante
JavaScript
Estrellas
0
Forks
0
Métricas de merge de PR
Sin PR fusionados en 30 d

Preparar el entorno

Este proyecto no incluye contenedor de desarrollo, Dockerfile ni guía de contribución, así que la configuración corre por tu cuenta: empieza por su README y consulta nuestra guía para la primera contribución para los pasos generales.

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de indexzero/hyperdown

Todos los issues de indexzero/hyperdown

Issues similares

Más issues de JavaScript

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.