mapbox / mapbox/cpp

Add narrative documentation on how we do binary deployment

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

Nadie ha tomado este issue todavía.

Lenguaje dominante
Sin datos de lenguaje
Estrellas
110
Forks
17
Métricas de merge de PR
Sin PR fusionados en 30 d

Descripción

Now that our https://github.com/mapbox/cpp/blob/master/glossary.md is fairly complete, it is a good time to add new, narrative docs that tie together glossary terms.

In particular, there is a need for a binary deployment doc that explains the flow from C++ source code -> node addons -> binary distribution.

Here is a first stab at listing things to cover in this doc:

We use mason for:

  • distributing pre-compiled (aka binary) static libraries for C/C++ code. And in rare cases shared libraries.
  • distributing source code of header-only libraries
  • distributing binaries of executables (aka command line programs).

We use node-pre-gyp for:

  • Binary deployment of node C++ addons
  • When those node C++ addons have external C/C++ dependencies we use mason to pull packages for them
  • Soon we'll open source https://github.com/mapbox/mason-js which will make these more seamless (no need for the mason bash scripts)

TODO:

Guía de contribución

Abrir la guía de contribución

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.

Línea de trabajo

Comienza con glossary.md y las páginas existentes de la wiki de node-pre-gyp sobre External-libraries y FAQ. Sigue el flujo documentado desde el código fuente de C++ pasando por los node addons hasta la distribución de binarios, cubriendo mason y node-pre-gyp, y luego integra la documentación antigua relevante en este repositorio con enlaces al glosario y al material relacionado.

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

Evaluación

Stack tecnológico
cpp, nodejs
Área
build-system, documentation, release
Tipo de issue
Documentación
Dificultad
4/5
Tiempo estimado
3-5 días
Estado de actividad
Estancado
Claridad
Bastante claro
Aptitud para principiantes
45/100

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.