Ajuda e feedback
Travou, achou um bug ou teve uma ideia? Escolha o canal certo e siga o roteiro curto abaixo. Você pode escrever em português (Brasil) ou em inglês.
Para onde ir
Seção intitulada “Para onde ir”| Você quer | Vá para |
|---|---|
| Tirar uma dúvida (como fazer algo, por que algo se comporta de um jeito) | Discussions |
| Relatar um bug (algo não funciona como os guias dizem) | Relato de bug |
| Sugerir algo | Pedido de funcionalidade, ou Discussions se ainda for uma ideia para conversar |
| Relatar um problema de segurança | Em privado, por um relato de segurança. Leia antes o SECURITY.md. Não abra uma issue pública. |
| Falar com a gente sem conta no GitHub | Escreva para contato@tws.tec.br |
Antes de escrever, veja o guia de solução de problemas e procure nas issues e nas discussões que já existem: alguém pode já ter a resposta.
O que informar num relato de bug
Seção intitulada “O que informar num relato de bug”O formulário de bug pede estes itens. Ter tudo à mão evita uma rodada de perguntas.
- Versão do painel. Na VPS, rode
git -C /opt/tws-panel rev-parse --short HEAD. Ele mostra o código curto do commit. Se você chegou ao formulário pelo menu de ajuda do painel, este campo pode já vir preenchido: confira. - Sistema operacional da VPS. Por exemplo “Ubuntu 24.04”, mais a versão do Docker
(
docker --version). Para ver o sistema:cat /etc/os-release. - Idioma da interface. Português (Brasil) ou inglês.
- Passos para reproduzir. O que você clicou ou rodou, em ordem, e o que esperava que acontecesse no lugar do que aconteceu.
- Evidências, como uma captura de tela ou um trecho de log, depois de tirar os dados privados (próxima seção).
Não cole logs sem revisar
Seção intitulada “Não cole logs sem revisar”Logs, capturas de tela e saídas de comandos podem conter domínios, endereços IP, e-mails e tokens. Uma issue ou uma discussão é pública: qualquer pessoa pode ler. Antes de colar qualquer coisa:
- Troque os seus domínios por
example.com(e os subdomínios porapp.example.com,mail.example.com). - Troque os endereços IP por
203.0.113.10(um endereço reservado para documentação). - Troque os e-mails por
usuario@example.com. - Troque tokens, senhas e chaves por
REDACTED. - Recorte as capturas de tela para não mostrar domínios, IPs, nomes de projetos nem o setup token na barra de endereço.
Para mascarar os endereços IP de um log automaticamente, rode isto na VPS e leia o resultado antes de copiar (o comando não conhece os seus domínios nem os seus tokens):
sudo docker logs --tail 100 tws-panel 2>&1 \ | sed -E 's/[0-9]{1,3}(\.[0-9]{1,3}){3}/203.0.113.10/g'Contato direto
Seção intitulada “Contato direto”Sem conta no GitHub, ou o assunto não serve para uma página pública? Escreva para contato@tws.tec.br. Vale a mesma regra: nada de tokens, senhas ou logs sem revisar na mensagem. Para uma vulnerabilidade de segurança, prefira o relato privado acima.