Add narrative documentation on how we do binary deployment
Ninguém assumiu esta issue ainda.
Avaliação
- Dificuldade
- 4/5
- Tempo estimado
- 3-5 dias
- Facilidade para iniciantes
- 45/100
- Tipo de issue
- Documentação
- Clareza
- Razoavelmente clara
- Status de atividade
- Estagnada
- Stack de tecnologia
- cpp, nodejs
- Domínio
- build-system, documentation, release
Direção de pesquisa
Comece com glossary.md e com as páginas existentes da wiki do node-pre-gyp sobre External-libraries e FAQ. Percorra o fluxo documentado desde o código-fonte C++ passando pelos node addons até a distribuição de binários, abrangendo mason e node-pre-gyp, e depois integre a documentação antiga relevante a este repositório com links para o glossário e o material relacionado.
Escrita pelo modelo de indexação a partir do texto da issue.
Descrição
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:
- integrate old node-pre-gyp docs into this repo and modify them to link to the glossary and this repo where appropriate. E.g. https://github.com/mapbox/node-pre-gyp/wiki/External-libraries, https://github.com/mapbox/node-pre-gyp/wiki/FAQ
- Linguagem predominante
- Sem dados de linguagem
- Estrelas
- 110
- Forks
- 17
- Métricas de merge de PRs
- Nenhum PR com merge em 30d
Guia de contribuição
Primeiros passos
- Leia a issue inteira e depois o guia de contribuição do projeto.
- Comente na issue dizendo que vai assumir — evita que duas pessoas façam o mesmo trabalho.
- Faça um fork do repositório e trabalhe em uma branch.
- Abra um pull request que referencie o número da issue.
Mais de mapbox/cpp
-
glossary
Dificuldade 1/5 Menos de uma hora Facilidade para iniciantes 68/100
-
Dificuldade 3/5 1-2 dias Facilidade para iniciantes 25/100
-
Docs on ABIs Aberta
Dificuldade 4/5 3-5 dias Facilidade para iniciantes 30/100
-
clang-tidy v. -Weffc++ Aberta
Dificuldade 5/5 Mais de uma semana Facilidade para iniciantes 30/100
-
Dificuldade 3/5 1-2 dias Facilidade para iniciantes 35/100
Issues semelhantes
-
nix: vendorHash is outdated Aberta
Dificuldade 1/5 Menos de uma hora Facilidade para iniciantes 90/100
-
bug
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 75/100
typelevel/sbt-typelevel#929 ·
-
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 70/100
openSUSE/python-rpm-macros#219 ·
-
HMR stops working Aberta
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 75/100
-
Dificuldade 1/5 Menos de uma hora Facilidade para iniciantes 90/100
Qiskit/mcp-servers#221 ·