Bug reporting guidelines (Português)

Status de tradução:
Esse artigo é uma tradução de
Bug reporting guidelines
. Data da última tradução: 2020-04-14. Você pode ajudar a sincronizar a tradução, se houver
alterações
na versão em inglês.
Artigos relacionados
Solução de problemas gerais
Guia de depuração passo a passo
Depuração - Obtendo Rastros
Abrir (e fechar) relatórios de erros no
Rastreador de erros do Arch Linux
(também conhecido como
Arch Linux Bugtracker
) é uma das muitas maneiras possíveis de
ajudar a comunidade
. No entanto, relatórios de erros mal formulados podem ser contraproducentes. Quando os erros são incorretamente relatados, os desenvolvedores perdem tempo investigando e fechando relatórios inválidos. Este documento irá guiar qualquer pessoa que deseje ajudar a comunidade informando eficientemente e buscando erros.
Veja também:
Como relatar erros de forma efetiva
(em inglês) por Simon Tatham
Antes de relatar
Preparar um relatório de erros detalhado e bem formado não é difícil, mas requer um esforço do relatante.
O trabalho feito antes de relatar um erro é indiscutivelmente a parte mais útil do trabalho
. Infelizmente, poucas pessoas tomam o tempo para fazer isso funcionar corretamente.
Os passos a seguir vão lhe guiar na preparação de seu relatório de erro ou requisição de recurso.
Pesquise por duplicados
Se você encontrar um problema ou desejar um novo recurso, existe uma grande probabilidade de que alguém já tenha esse problema ou ideia. Se assim for, um relatório de erro apropriado já pode existir. Nesse caso, não crie um relatório duplicado; veja
#Acompanhando relatórios
.
Pesquise detalhadamente as informações existentes, incluindo:
Fóruns do Arch Linux
: Os fóruns são muitas vezes a primeira parada para usuários que procuram ajuda ou compartilhar ideias. Ainda que não exista uma solução, informações detalhadas e discussão adicional podem orientá-lo na direção certa.
Rastreador de Erros do Arch Linux
: Seu problema talvez já tenha sido relatado aos desenvolvedores do Arch Linux. Relatórios de erros duplicados são inúteis e prontamente fechados. Pesquisa por tanto  relatório de erros fechados como os relatórios abertos escolhendo "All Statuses" em Advanced. Lembre-se de marcar "search details" (detalhes da pesquisa) e/ou "search comments" (pesquisar comentários) em Advanced, pois o título do relatório pode não conter o texto que você está procurando.
Google
ou seu mecanismo de pesquisa favorito: Pesquise usando o nome do programa, versão e uma parte relevante da mensagem de erro, se houver.
Fórum, lista de discussão e rastreador de erro do
Upstream
: Se o Arch Linux não é responsável por um erro, ele deve ser relatado no upstream em vez do Rastreador de Erros do Arch Linux. Procure os erros recentemente fechados, bem como relatórios abertos. Erros podem já ter sido corrigidos na versão de desenvolvimento do programa.
Fóruns de outras distribuições
: A comunidade de software livre é vasta; usuários do Arch não são os únicos usuários com ideias! Considere pesquisar nos
Fóruns do Gentoo
,
FedoraForum.org
e
Fóruns do Ubuntu
, por exemplo.
Upstream ou Arch?
Arch Linux é uma
distribuição
GNU/Linux. Desenvolvedores do Arch e Trusted Users são responsáveis por compilar, empacotar e distribuir software de uma ampla gama de fontes.
Upstream
refere-se àqueles
fontes
– os autores originais ou mantenedores do software que é distribuído no Arch Linux. Por exemplo, o popular navegador web Firefox é desenvolvido pelo Projeto Mozilla.
Se o Arch não for responsável por um erro, o problema não será resolvido relatando o erro aos desenvolvedores do Arch.
A responsabilidade por um erro é dito ser do upstream quando não é causado pelos esforços de distribuição e integração da distribuição.
Ao relatar erros ao upstream, você não só ajudará os usuários e desenvolvedores do Arch, mas também ajudará outras pessoas na comunidade de software livre, pois a solução afetará todas as distribuições.
Assim que você relatar um erro no upstream ou encontrar outras informações relevantes do upstream, pode ser útil publicar isso no rastreador de erros do Arch, de modo que os desenvolvedores e os usuários do Arch sejam informados disso.
Então, pelo que o Arch Linux é responsável?
Projetos do Arch Linux
:
pacman
,
AUR
,
mkinitcpio
e sites do Arch. Se você tiver dúvidas sobre se o projeto pertence ao Arch ou obtenha estas informações do pacote (
pacman -Qi
nome_pacote
ou usando o site) e veja o URL do upstream.
Empacotamento
: O empacotamento basicamente consiste em buscar o código fonte do upstream, compilando-o com as opções relevantes, certificando-se de que ele será instalado corretamente em um sistema Arch e verificando se a funcionalidade principal funciona. O empacotamento no Arch não consiste em adicionar novas funcionalidades ou patches para erros existentes; este é o trabalho do desenvolvedor upstream.
Se um erro/recurso não está sob a responsabilidade do Arch, relate-o ao upstream. Veja também
#Motivos para não ser um erro
.
Erro ou recurso?
erro
(bug)
alguma coisa que deve funcionar, mas não funciona, contrário às intenções dos desenvolvedores.
recruso
(feature)
alguma coisa que o software faz ou faria se alguém o codificasse.
Motivos para não ser um erro
Algo que você gostaria que uma parte do software fizesse, o que não foi implementado pelos desenvolvedores upstream. Em resumo:
um novo recurso
.
Um erro já realtado no upstream.
Um erro já corrigido no upstream, mas não no Arch porque o pacote não está desatualizado.
Um pacote que está atualizado
. Use o recurso
Flag Package Out-of-Date
no
site de pacotes do Arch
.
Um pacote que não usa patches do Fedora, Ubuntu ou outra comunidade.
Patches devem ser enviados para o
upstream
.
Um pacote que a
função não essencial
X ou a função Y não estejam ativados. Isso é uma requisição de recurso.
Um pacote que não inclui um
arquivo .desktop
ou
ícones
ou outra coisa do
freedesktop
. Este não é um erro se tais arquivos não estiverem incluídos no tarball fonte, e isso deve ser solicitado como uma requisição de recurso no
upstream
. Se esses arquivos forem fornecidos pelo
upstream
, mas não utilizados na empacotamento, então isso é um erro.
Motivos para não ser um recurso
Quando é um erro...
Quando não estiver sob a responsabilidade do Arch implementar o recurso, ou seja, um
recurso do upstream
.
Um pacote não está atualizado. Use o recurso
Flag Package Out-of-Date
em
site de pacotes do Arch
.
Um pacote que não usa patch do Fedora, Ubuntu ou de alguma outra comunidade.
Os patches devem ser enviados para o
upstream
.
Colete informações úteis
Aqui está uma lista de informações úteis que devem ser mencionadas no seu relatório de erros:
Versão do pacote
sendo usado.
Sempre especifique a versão do pacote
. Dizer "a última", "atual" ou "o pacote no extra" não tem nenhuma sentido. Especialmente se o erro não está para ser corrigido imediatamente.
Versão das principais bibliotecas utilizadas pelo pacote (disponível na variável
depends
no PKGBUILD), quando estão envolvidas no problema. Se você não sabe exatamente quais informações fornecer, espere que um caçador de bugs peça a você...
Versão do kernel usada se você está tendo problemas relacionados ao hardware.
Indique se
a funcionalidade funcionou em algum momento
ou não. Se sim, indique desde quando parou de funcionar.
Indique a sua
marca de hardware
quando tiver problemas relacionados com hardware
Adicione
informações de log relevantes
quando estiver disponível. Isso pode ser obtido nos seguintes locais, dependendo do problema:
O
journal do systemd
. Se estiver usando
syslog-ng
,
/var/log/messages
contém logs relacionados a kernel e problemas relacionados ao hardware.
~/.local/share/xorg/Xorg.0.log
ou
/var/log/Xorg.0.log
ou
/var/log/Xorg.2.log
ou a qualquer arquivo de log tipo Xorg se problemas relacionados a vídeo (nvidia, ati, xorg...)
Execute seu programa em um
console
e use o modo
verboso
(verbose)
e/ou
depuração
(debug)
se disponível (veja a documentação do programa) e copie a saída em um arquivo. Ao executar um aplicativo em um terminal, certifique-se de que informações relevantes serão exibidas em
inglês
, de forma que mais pessoas possam entendê-la. Isso pode ser feito usando
export LC_ALL="C"
. Exemplifique com um software chamado
foobar
do qual você gostaria de ter informações relevantes em tempo de execução e considerando que
foobar
tem uma opção
--verbose
:
$ export LC_ALL="C"
$ foobar --verbose
Isso afetará apenas o terminal atual e parará de funcionar quando o terminal for fechado.
Se você tiver que colar muito texto, como a saída do dmesg, ou um log do Xorg, é preferível salvá-lo como um arquivo no seu computador e anexá-lo ao seu relatório de erros. Anexar um arquivo em vez de usar um pastebin para apresentar informações relevantes é preferível em geral, devido ao fato de que o conteúdo colocado em um pastebin pode ter seu link expirado ou quaisquer outros problemas potenciais.
Anexar um arquivo garante que as informações fornecidas estarão sempre disponíveis
.
Indique como reproduzir o erro
. Isso é muito importante, ajudará as pessoas a testar o erro e possíveis patches em seu próprio computador.
O rastro da pilha
(stack trace)
. É uma lista de chamadas feitas pelo programa durante sua execução e ajuda a encontrar a parte do programa onde o erro está localizado, especialmente se o erro envolver o travamento do programa. Você pode obter um rastro de pilha usando
gdb
(O GNU Debugger) como explicado em
Depuração - Obtendo Rastros#Obtendo o rastro
.
Abrindo um relatório
Quando tiver certeza de que é um erro ou um recurso e você coletou todas as informações úteis, então você está pronto para abrir um relatório de erro ou solicitação de recurso.
Criando uma conta
Você tem que criar uma conta no
sistema de rastreamento de erros do Arch
. Isso é tão fácil quanto criar uma conta em um wiki ou um fórum e não há nada de especial para mencionar aqui.
Projetos
Depois de determinar que seu recurso ou bug está relacionado ao Arch e não a um problema de upstream, será necessário relatar seu problema no projeto correto. Selecione o projeto na lista suspensa
à esquerda do botão "Swtich"
no canto superior esquerdo da página de criação de relatórios de erros (
não
à direita de "Category"). Existem cinco projetos:
Arch Linux
- para pacotes em
testing
,
core
ou
extra
. Também é um lugar para documentação, sites (exceto AUR) e problemas de segurança.
AUR web interface
- para o código do site do AUR e problemas em seu servidor. Isso não inclui aplicativos de terceiros usados para acessar o AUR ou pacotes no
unsupported
.
Community Packages
- para pacotes no
community
. Não é um lugar para pacotes no
unsupported
.
Pacman
- para
pacman
e os scripts e ferramentas oficiais associadas a ele. Isso inclui coisas como o makepkg. Isso não inclui pacotes desenvolvidos pela comunidade, como os
auxiliares do AUR
.
Release Engineering
- destinado a todos os problemas relacionados à lançamentos (isos, instalador etc.)
Não há lugar para relatar problemas com pacotes no
unsupported
. O AUR fornece uma maneira de adicionar comentários a um pacote no
unsupported
. Você deve usar isso para relatar erros ao mantenedor do pacote.
Resumo
Por favor, escreva um resumo
(Summary)
conciso e descritivo.
Aqui está uma lista de recomendações:
Não
nomeie seu relatório "
pkgname
is broken after the last update" - isso não é descritivo e "after the last update" não tem sentido no Arch.
Inicie o Summary com o nome do pacote envolto com colchetes, p. ex.. "
[
pkgname
]
3.0.5-1 breaks copy-paste feature". Ao nomear relatórios dessa forma, você facilita para desenvolvedores a ordenarem relatórios por nomes de pacotes.
Não escreva muito texto no Summary. Texto excessivo não será visível na lista de relatórios.
Severidade
Escolher uma severidade
crítica
(em inglês,
Severity
) não ajudará a resolver o erro mais rápido. Isso só tornará os problemas realmente críticos menos visíveis e provavelmente fará com que o desenvolvedor atribuído ao seu relatório fique menos aberto para corrigi-lo.
Aqui está um uso geral de severidades:
Critical
- Queda do sistema, falha grave de inicialização que provavelmente afetará mais do que apenas você ou um problema de segurança explorável em um pacote de serviços principal ou externo.
High
- A principal funcionalidade do aplicativo não funciona, menos problemas críticos de segurança, etc.
Medium
- Uma funcionalidade não essencial não funciona, padrões UNIX não são respeitados, etc.
Low
- Uma funcionalidade opcional (plug-in ou compilação ativado) não funciona.
Very Low
- Erro de tradução ou documentação. Algo que realmente não importa muito, mas deve ser notado para uma versão futura.
Incluindo informações relevantes
Esta é talvez uma das partes mais difíceis de relatar erros. Você tem que escolher na seção
#Colete informações úteis
quais informações você irá adicionar ao seu relatório de erros. Isso vai depender de qual é o seu problema. Se você não sabe quais são as informações relevantes, não seja tímido:
é melhor fornecer mais informações do que é necessário a não ter o suficiente
.
Um bom tutorial sobre relatório de erro pode ser localizado em
[1]
.
No entanto, os desenvolvedores ou caçadores de erros solicitarão mais informações, se necessário. Felizmente, depois de alguns relatos de erros, você saberá quais informações devem ser fornecidas.
Informações curtas podem ser inseridos no corpo do relatório de erro, enquanto
informações longas (logs, capturas de telas...) devem ser anexados
.
Acompanhando relatórios
Não pense que o trabalho está feito depois de ter relatado um bug
!
Os desenvolvedores ou outros usuários provavelmente pedirão mais detalhes e darão algumas correções em potencial para você tentar. Sem feedback contínuo, os bugs não podem ser fechados e o resultado final é de usuários e desenvolvedores irritados.
Votando e monitorando
Você pode
votar
nos seus relatórios de erros favoritos. O número de votos indica para os desenvolvedores quantas pessoas são impactadas pelo erro. No entanto, esta não é uma maneira muito eficaz de resolver o problema. Muito mais importante seria publicar qualquer informação adicional que você conheça sobre o erro se você não fosse o relator original.
Monitorar
um relatório de erro é importante - você receberá um e-mail quando novos comentários forem adicionados ou o status do relatório for alterado. Se você abriu um relatório, verifique se a caixa de seleção "Notify me whenever this task changes" está ativada para receber esses e-mails.
Respondendo solicitações de informações adicionais
As pessoas analisarão o seu relatório de erros e tentarão ajudá-lo. Você precisa continuar a ajudá-los a resolver seu relatório de erro. Não responder às suas perguntas irá manter o seu relatório não resolvido e provavelmente dificultará o entusiasmo para consertá-lo.
Por favor, reserve um tempo para dar mais informações às pessoas, se solicitado, e tente as soluções propostas
.
Desenvolvedores ou caçadores de erros fecharão seu relatório se você não responder a perguntas depois de algumas semanas ou um mês.
Atualizando o relatório de erro quando surgir uma nova versão do software relatado
Às vezes, um relatório de erro está relacionado a uma determinada versão do pacote e é corrigido em uma nova versão. Se este for o caso, indique nos comentários do relatório de erros e solicite um encerramento.
Fechando quando resolvido
Às vezes, as pessoas relatam um erro, mas não notificam quando o resolvem por conta própria, deixando as pessoas procurando por uma solução que já tenha sido encontrada. Por favor, solicite um fechamento se você encontrou uma solução e forneça a solução nos comentários do relatório de erros.
Mais sobre status de relatórios
Durante sua vida, um relatório de erro passa por vários status:
Unconfirmed
(Não confirmado)
- Este é o status padrão. Você acabou de relatá-lo e ninguém conseguiu reproduzir o problema ou confirmar que é realmente um erro.
New
(Novo)
- O erro está confirmado, mas não foi atribuído ao desenvolvedor responsável pelo software relacionado. Geralmente é o caso quando mais investigação é necessária para determinar qual software é responsável pelo erro.
Assigned
(Atribuído)
- O relatório foi atribuído a um desenvolvedor responsável pelo software envolvido no relatório. Isso não significa que o desenvolvedor será quem corrigirá o erro. Isso não significa que o desenvolvedor vai trabalhar em uma solução. Significa apenas que o desenvolvedor vai cuidar do ciclo de vida do relatório, incluindo a revisão de patches, se houver, lançando uma correção e fechando o relatório quando necessário. Não faz sentido entrar em contato diretamente com um desenvolvedor para ter um erro corrigido mais rapidamente, ele/ela certamente não gostará disso...
Researching
(Pesquisando)
- Alguém está procurando uma solução. Este status é
raramente usado no Arch
e é melhor assim. O status de
pesquisa
pode fazer as pessoas acreditarem que não precisam se interessar pelo relatório de erros. Mas geralmente precisamos de mais de uma pessoa para consertar um erro: ter várias pessoas experientes em um relatório ajuda muito.
Waiting on Response
(Aguardando resposta)
e
Requires testing
(Requer teste)
- Aquele que relatou o erro foi solicitado a fornecer mais informações ou a tentar uma solução proposta, mas ele ainda não deu um feedback. Esses status são raramente usados no Arch e deveriam ser usados com mais frequência. No entanto, é importante que você
monitore o relatório
(consulte a seção
#Votando e monitorando
), já que desenvolvedores ou caçadores de erros costumam fazer perguntas nos comentários.
A task closure has been requested
(Um fechamento de tarefa foi requisitado)
- Este não é exatamente um status, mas você pode encontrar alguns relatórios de erros com essa notificação. Isso indica que alguém solicitou um fechamento para o relatório. Um motivo é adicionado à solicitação na maioria das vezes. Cabe ao desenvolvedor responsável decidir se ele aceitará o encerramento ou não.
Closed
(Fechado)
- Ou esse não é um relatório válido (veja
#Motivos para não ser um erro
) ou uma solução foi encontrada e foi lançada.
Algumas pessoas (desenvolvedores, TUs ...) são responsáveis por despachar os erros e alterar seu status.