Agradecemos por contribuir com a documentação do Bazel. Existem algumas maneiras de criar documentos melhores para nossa comunidade.
Tipos de documentação
Este site inclui alguns tipos de conteúdo.
- Documentação narrativa, que é escrita por redatores técnicos e engenheiros. A maior parte deste site é 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 mudanças nas páginas de documento de referência diretamente, mas é necessário mudar a fonte delas.
Infraestrutura de documentação
A documentação do Bazel é fornecida pelo Google, e os arquivos de origem são espelhados no repositório do Bazel no GitHub. Você pode fazer mudanças nos arquivos de origem no GitHub. Se for aprovado, você poderá mesclar as mudanças, e um mantenedor do Bazel vai atualizar a fonte do site para publicar suas atualizações.
Pequenas mudanças
Você pode fazer 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 ou em uma ramificação.
- Bug. Você pode registrar um bug com detalhes e mudanças sugeridas, e os proprietários da documentação do Bazel vão fazer a atualização.
Mudanças grandes
Se você quiser fazer mudanças substanciais na documentação atual ou propor uma nova, crie uma solicitação de pull ou comece com um documento do Google e entre em contato com os proprietários do Bazel para colaborar.