mapbox / mapbox/cpp

Dual docs for llvm usage: cli and Xcode

Aberta
#8 0 comentários 0 reações 0 responsáveis Ver no GitHub

Ninguém assumiu esta issue ainda.

Linguagem predominante
Sem dados de linguagem
Estrelas
110
Forks
17
Métricas de merge de PRs
Nenhum PR com merge em 30d

Descrição

XCode/Apple is driving the development of llvm tools. These tools can and do work on the command line on both os x and linux. So we should prioritize documenting cli usage in a cross platform way. However users of XCode, notably for mobile development, can and should prefer to use features of llvm like the sanitizers from within Xcode GUI (with the caveat that at the time of writing Xcode only supports the address sanitizer and not thread, memory, undefined).

As such our docs ideally should target the three ways you'd use llvm:

  • cli on linux (installed with mason)
  • cli on osx (installed with mason or recent Xcode command line tools - identical behavior to linux except for missing sanitizers)
  • XCode UI on OS X for macOS and iOS development (installed with XCode)

Guia de contribuição

Abrir o guia de contribuição

Primeiros passos

  1. Leia a issue inteira e depois o guia de contribuição do projeto.
  2. Comente na issue dizendo que vai assumir — evita que duas pessoas façam o mesmo trabalho.
  3. Faça um fork do repositório e trabalhe em uma branch.
  4. Abra um pull request que referencie o número da issue.

Direção de pesquisa

Nenhum arquivo ou teste é nomeado. Comece localizando a documentação existente do LLVM e seus pontos de entrada de CLI e Xcode; em seguida, mapeie os workflows solicitados para CLI no Linux, CLI no macOS e a UI do Xcode. O trabalho estará concluído quando os três caminhos de uso e suas limitações de sanitizer estiverem documentados entre as plataformas.

Escrita pelo modelo de indexação a partir do texto da issue.

Avaliação

Domínio
cli, devtools, documentation
Tipo de issue
Documentação
Dificuldade
4/5
Tempo estimado
3-5 dias
Status de atividade
Estagnada
Clareza
Razoavelmente clara
Facilidade para iniciantes
35/100

Receba novas issues na sua caixa de entrada

Um resumo curto de issues do GitHub para quem está começando.