Outros idiomas Deutsch ; English ; Français ; Nederlands ; Português (Portugal) ; Türkçe ; português brasileiro ; |
Sinopse: Esta página irá ajudá-lo a entender o que são bugs, quando e como eles devem ser relatados e no que prestar atenção. Relatórios de bugs eficazes têm maior probabilidade de serem corrigidos. Estas diretrizes explicam como redigir tais relatórios.
|
Contents
Definição
O que são bugs exatamente? Um bug é o termo comum usado para descrever um erro, falha, defeito, problema ou falha em um programa ou sistema de computador que produz um resultado incorreto ou inesperado ou faz com que ele se comporte de maneiras não intencionais. Mas um bug não está restrito ao software; bugs podem estar em qualquer lugar, no software, no hardware, nas pessoas que mantêm qualquer um deles, até mesmo na comida de alguém (trocadilho intencional). Basicamente, se há um problema reproduzível, seja na documentação, tradução, arte, websites ou infraestrutura, ou até mesmo com o próprio Mageia.Org, um de seus colaboradores, ou a organização das equipes, isso pode ser relatado como um bug. Além disso, solicitações de pacotes também são bugs, para dar alguns exemplos.
Princípios
- Seja preciso
- Seja claro - explique de forma que outros entendam o bug claramente
- Um bug por relatório
- Reproduza o bug - Se o bug que você deseja relatar não puder ser reproduzido pela sua descrição (em outro computador ou em uma instalação nova do Mageia), as chances de ele ser corrigido são muito menores. Os desenvolvedores precisam reproduzir os bugs para corrigi-los na maioria dos casos
- Sempre é uma boa ideia perguntar nos fóruns ou em uma das listas de discussão se alguém consegue reproduzir o problema ou também vê o bug
- Tente buscar relatórios de bugs relacionados ao software que você está relatando, por exemplo, para KDE em https://bugs.kde.org/ ou para systemd em https://bugs.freedesktop.org
também certifique-se de buscar pelo problema no Google ou similar para verificar se este não é um problema conhecido - Nenhum bug é trivial demais para ser relatado - bugs pequenos podem esconder problemas maiores
- Separe claramente fatos de especulações
- Sempre prefira chamadas a programas com o prefixo LC_ALL=C para que mensagens de erro ou outras saídas sejam exibidas em inglês, por exemplo:
Não rode urpmi algum_pacote, mas LC_ALL=C urpmi algum_pacote- Alguns aplicativos podem não iniciar em inglês com LC_ALL=C. Nesse caso, tente LC_ALL=en_US.UTF-8 ou LANGUAGE=C
Preliminares
- Certifique-se de usar uma versão do Mageia suportada e totalmente atualizada
- Acesse https://bugs.mageia.org e pesquise no Bugzilla para verificar se o seu bug já foi relatado.
- Você pode usar a pesquisa rápida, inserindo alguns termos relevantes
- Colocar as letras **ALL** como o primeiro termo na string de pesquisa retornará todos os relatórios de bugs relevantes, incluindo os já resolvidos.
- Se "seu" bug já estiver lá, você pode deixar um comentário no relatório confirmando o bug. Caso não tenha certeza se é o mesmo, peça ajuda no IRC ou nos fóruns.
Relatando um novo bug
Se você reproduziu o bug em uma versão mais recente do software e ninguém mais parece tê-lo relatado, siga os passos abaixo:
- Faça login na sua conta (primeiro, será necessário criar uma; veja a FAQ sobre contas de usuários Mageia.org)
- Clique em "File a Bug" (se você não encontrou o mesmo bug antes com o campo de pesquisa)
- Escolha "Enter a new bug". Você pode optar pelo "formulário guiado" ou, se já fez isso antes, use o formulário padrão
- Selecione o produto no qual encontrou o bug (disponível apenas no formulário avançado). No formulário guiado, "Mageia" já está pré-selecionado. Para relatar bugs nos sites ou infraestrutura do Mageia (como o Bugzilla ou o sistema de construção), use o formulário padrão (veja acima)
- Informe o Source RPM[1] do pacote
- Preencha o formulário. Aqui estão algumas dicas para entender os campos:
Component: Em qual subparte do software o bug existe? Este campo é obrigatório. Clique na palavra "Componente" para ver uma descrição de cada um. Se nenhum parecer adequado, selecione **Pacotes RPM**.
Version: Em qual versão suportada da distribuição o bug existe?
As versões 1-8 não são mais suportadas. A versão 9 é a estável atualmente suportada e o cauldron é a versão em desenvolvimento.
Se você sabe que o bug existe em duas ou mais versões do Mageia, configure-o para a versão mais alta e adicione as versões inferiores no campo "Whiteboard". O *cauldron* é superior à versão "9" e, assim que o Mageia 10 for lançado, também será superior à versão "10". Portanto, até o lançamento do Mageia 10, para um bug válido para todas as versões:
- Defina a versão como Cauldron
- Coloque
MGA8TOO
no campo whiteboard
Após o lançamento do Mageia 10:
- Defina a versão como Cauldron
- Coloque
MGA8TOO, MGA9TOO
no campo whiteboard
Hardware: Em qual arquitetura o bug ocorre? i586 significa 32 bits, x86_64 significa 64 bits, arm refere-se à arquitetura ARM e all significa que ocorre em todas as arquiteturas (o caso mais comum).
Source RPM: Use este campo para identificar exatamente qual pacote RPM está envolvido no relatório de bug.
Por exemplo, se você sabe que o problema está no programa mysqld, execute rpm -qif /usr/sbin/mysqld. Isso fornecerá o nome e a versão do pacote RPM (ex.: MySQL-5.0.27-1mga1), além de outras informações. Especificamente, você está procurando o campo "Source RPM" (ex.: MySQL-5.0.27-1mga1.src.rpm), que é a informação a ser fornecida aqui. Alternativamente, você pode usar: rpm -qf /usr/sbin/mysqld --qf '%{SOURCERPM}\n'. Se não souber a localização do programa em questão, use rpm -qf `which mysqld`.
URL: URL que demonstre o problema relatado (opcional). Pode ser uma postagem em fórum onde o problema foi originalmente relatado, um relatório de bug upstream ou em outra distribuição sobre o mesmo problema que você está relatando.
Summary: Como você descreveria o bug em aproximadamente 60 ou menos caracteres? Um bom resumo deve identificar o relatório de bug de forma rápida e única. Ele deve explicar o problema, e não a solução sugerida. Seja descritivo e use muitas palavras-chave.
- Bom exemplo: Falha no Evolution ao verificar novos e-mails POP
- Mau exemplo: E-mail travou
- Bom exemplo: Cancelar um diálogo de cópia de arquivos trava o gerenciador de arquivos
- Mau exemplo: Software trava
- Mau example: Navegador deveria funcionar com meu site
Details: Os detalhes do seu relatório de problema, incluindo:
Description: Reafirmação mais detalhada do resumo. Expanda o Resumo. Seja o mais específico possível sobre o que está errado.
- Mau exemplo: Não consigo fazer login no sistema. Por favor, ajude!
- Bom exemplo: Não consigo fazer login no sistema via SSH. O log /var/log/messages indica um problema com o módulo pam_ldap, mas o arquivo /etc/pam.d/system-auth não contém esse módulo e eu não uso LDAP. Verifiquei o arquivo /etc/pam.d/sshd e ele contém esse módulo, mas não sei como ele foi parar lá, a menos que tenha sido por causa do pacote super-spiffy super-ldap-mojo que instalei ontem.
Versão-lançamento do componente selecionado (se aplicável):
openldap-2.3.34-5mga1, pam-0.99.7.1-2mga1
Com que frequência ocorre:
Sempre que tento fazer login.
Passos para reproduzir: Passos breves e fáceis de seguir que acionem o bug. Inclua qualquer etapa de configuração especial.
- ssh user@host
- see the rejection
Para bugs que causam falhas:
Consulte a página Depurando falhas de software para aprender como produzir e fornecer as informações de depuração necessárias (backtraces) no caso de o software falhar ou gerar uma falha de segmentação (segfault)
- Adicione um anexo se isso puder ajudar (não todos os seus logs, apenas o log relacionado ao problema).
Consulte o guia de triagem para verificar se informações mais específicas são necessárias no seu relatório de bug, o que pode reduzir o trabalho da equipe de triagem.
- Se souber, insira o e-mail do mantenedor[2] do pacote no campo Assign To (ou deixe que a equipe de triagem o adicione)
Verifique novamente o relatório para garantir que não há erros ou omissões, e então pressione "Submit Bug Report". Seu relatório de bug estará agora na base de dados do Bugzilla.
[1], [2]: rpm -qi package
fornecerá muitas informações sobre um pacote.
Partes desta página foram extraídas do Bugzilla upstream, de uma página sobre como escrever relatórios de bugs para o Bugzilla 3.6, que não existe mais. Informações atuais sobre como usar o Bugzilla podem ser encontradas aqui: https://bugzilla.readthedocs.io/en/5.0.4/using/index.html
Como registrar um pedido de pacote
Isso é semelhante a registrar um bug, mas há algumas diferenças nas informações necessárias.
- Acesse https://bugs.mageia.org
- Faça uma busca rápida por "ALL <nome_do_pacote>", substituindo "<nome_do_pacote>" pelo nome real do pacote
- Se alguém já registrou o pedido, adicione um comentário indicando que você também gostaria de ver o pacote no Mageia
- Se o pedido foi fechado como WONTFIX, isso provavelmente aconteceu porque o projeto foi descontinuado. Nesse caso, geralmente será indicado um pacote alternativo do Mageia.
- Se não encontrou nada na busca rápida, prossiga com o próximo passo:
- escolha File a Bug
- escolha o produto Mageia
- (Component:) escolha "New RPM package request"
- (Version:) escolha "Cauldron"
- (Hardware Platform:) escolha "All"
- (Source RPM:) não adicione um link aqui. Caso saiba o nome que o SRPM deve ter, adicione-o. Deixe em branco se não souber.
- (URL:http://) insira o link do site oficial do pacote
- (Summary) forneça o "nome do pacote", "e uma breve descrição de sua finalidade."
Exemplo: vagrant, uma ferramenta para construir ambientes virtualizados com o VirtualBox
- use apenas letras minúsculas no nome do pacote, isso facilitará futuras verificações sobre sua existência.
- (Details) explique por que você acha que o software é excelente e para que você precisa dele.
- (Severity) defina como "Enhancement"
- submit the report.