Issues

Corrigindo uma issue existente

Uma das melhores formas de contribuir para a melhoria da documentação do OTel é corrigir um problema já existente.

1. Navegue pela lista de issues.

2. Selecione uma issue com a qual você gostaria de contribuir, de preferência uma que possa ser resolvida em pouco tempo.

   É sua primeira contribuição?

   Procure por issues com os seguintes labels (rótulos):

   • Good first issue
   • Help wanted

   NOTA: nós não atribuímos issues a quem ainda não contribuiu com a organização OpenTelemetry, exceto quando fizer parte de um processo de tutoria ou de onboarding.

3. Leia os comentários existentes na issue, se houver.

4. Pergunte aos mantenedores se a issue ainda é relevante e esclareça eventuais dúvidas comentando na própria issue.

5. Declare sua intenção de trabalhar na issue adicionando um comentário.

6. Trabalhe na correção do problema. Caso enfrente dificuldades, avise os mantenedores.

7. Quando estiver pronto, submeta seu trabalho via pull request (PR).

Reportando um problema

Se você encontrar um erro ou quiser sugerir melhorias em conteúdos existentes, abra uma nova issue.

1. Clique no link Create documentation issue disponível em qualquer documento. Isso redirecionará você para uma página no GitHub com um modelo de issue pré-preenchido.
2. Descreva o problema ou sugestão de melhoria. Forneça o máximo de detalhes possível.
3. Clique em Create (Criar).

Após enviar a issue, acompanhe as atualizações ou ative as notificações do GitHub. Pode levar alguns dias até que mantenedores e aprovadores respondam. Revisores e membros da comunidade podem fazer perguntas antes de agir sobre sua issue.

Sugerindo novos conteúdos ou funcionalidades

Se você tem uma ideia para um novo conteúdo ou funcionalidade, mas não sabe exatamente onde ela se encaixa, ainda assim pode abrir uma issue. Também é possível relatar bugs ou vulnerabilidades de segurança.

1. Acesse a aba de Issues no GitHub.

2. Clique em New issue.

3. Escolha o tipo de issue mais apropriado para sua sugestão ou dúvida.

4. Preencha o modelo.

5. Envie a issue.

Como enviar boas issues

Ao criar uma issue, considere as seguintes boas práticas:

• Forneça uma descrição clara do problema. Explique exatamente o que está incorreto, desatualizado, ausente ou pode ser melhorado.
• Descreva o impacto específico do problema para os usuários.
• Limite o escopo da issue para uma quantia razoável. Problemas com escopo muito amplo devem ser divididos em issues menores. Por exemplo, “Corrigir a documentação de segurança” é vago demais; “Adicionar detalhes ao tópico ‘Restringindo o acesso à rede’” é específico o suficiente para ser acionável.
• Pesquise entre as issues existentes para ver se não há outra relacionada ou semelhante a sua nova issue.
• Se a nova issue estiver relacionada a outra issue ou pull request, faça referência usando a URL completa ou o número precedido por #, por exemplo: Introduzido por #987654.
• Siga o Código de Conduta. Respeite os demais colaboradores. Comentários como “A documentação está péssima” não são úteis nem apropriados.