Agradecemos por contribuir com a documentação do Bazel. Existem algumas maneiras de ajudar a criar documentos melhores para nossa comunidade.
Tipos de documentação
Este site inclui alguns tipos de conteúdo.
- Documentação narrativa, escrita por escritores e engenheiros técnicos. A maior parte deste site é uma documentação narrativa que abrange guias conceituais e baseados em tarefas.
- Documentação de referência, que é gerada a partir de comentários de código. Não é possível fazer alterações diretamente nas páginas de documentos de referência. Em vez disso, é necessário alterar a origem.
Infraestrutura de documentação
A documentação do Bazel é fornecida pelo Google e os arquivos de origem são espelhados no repositório do GitHub do Bazel. É possível fazer mudanças nos arquivos de origem no GitHub. Se aprovada, você pode mesclar as alterações, e um mantenedor do Bazel vai atualizar o fonte do site para publicar as atualizações.
Pequenas mudanças
É possível abordar pequenas mudanças, como corrigir erros ou erros de digitação, de algumas maneiras.
- Solicitação de envio: É possível criar uma solicitação de envio no GitHub com o editor baseado na Web (link em inglês) ou em uma ramificação.
- Bug: Você pode registrar um bug com detalhes e alterações sugeridas, e os proprietários da documentação do Bazel farão a atualização.
Grandes mudanças
Para fazer mudanças significativas na documentação atual ou propor uma nova, crie uma solicitação de envio ou comece com um documento do Google e entre em contato com os proprietários do Bazel para colaborar.