Agradecemos por contribuir com a documentação do Bazel. Há algumas formas de ajudar a 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 e engenheiros técnicos. A maior parte do 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 do documento de referência, mas é necessário alterar a origem delas.
Infraestrutura de documentação
A documentação do Bazel é disponibilizada pelo Google, e os arquivos de origem são espelhados no repositório do GitHub dele. É possível fazer alterações nos arquivos de origem no GitHub. Se aprovada, você poderá mesclar as alterações, e um administrador do Bazel atualizará a fonte do site para publicar suas atualizações.
Pequenas mudanças
Você pode 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 ou em uma ramificação.
- Bug: Você pode informar 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
Se você quiser fazer mudanças significativas em uma documentação ou propor novas, 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.