Use o modelo de tópico padrão para funcionalidades e bugs

Contribuir Feedback do site
1

Olá,

já que aprendi aqui que as categorias já oferecem modelos de tópicos, gostaria de sugerir o uso deles para as categorias Contribute > Feature e Contribute > Bug aqui no meta.discourse.org.

Não tenho certeza absoluta sobre o formato, então apenas peguei um modelo de issue do GitHub do Icinga e o modifiquei um pouco para o Discourse.

Contexto

Pela minha experiência, nem sempre fica claro o suficiente qual problema estamos realmente discutindo. Brincar de “ping-pong” para descobrir o ambiente, as possíveis ferramentas envolvidas e ideias que existem apenas no “cérebro” do usuário é demorado e, às vezes, exaustivo.

Eu imagino que um modelo de tópico padrão como esse poderia ajudar, lembrando os usuários quais detalhes são importantes ou como formatar geralmente sua “história”.

Geralmente, sou a favor de capítulos e títulos ao descrever um problema. Isso permite que todos acompanhem e selecionem os detalhes relevantes. Especialmente o contexto e informações adicionais sobre versões e insights específicos do navegador ajudam muito.

Uma coisa complicada com o modelo é que às vezes não se entende como os comentários HTML funcionam e por que eles ficam ocultos na visualização principal. Embora eu tenha visto muitos usuários apenas adotando-o e deixando como está.

Exemplo

<!--- Forneça um resumo geral da issue no Título acima -->

<!-- Por favor, certifique-se de ler https://meta.discourse.org/t/how-to-request-new-features-for-discourse/32986?source_topic_id=11 primeiro -->

## Comportamento Esperado
<!--- Se você está descrevendo um bug, diga-nos o que deveria acontecer -->
<!--- Se você está sugerindo uma mudança/melhoria, diga-nos como deveria funcionar -->

## Comportamento Atual
<!--- Se descrevendo um bug, diga-nos o que acontece em vez do comportamento esperado -->
<!--- Se sugerindo uma mudança/melhoria, explique a diferença em relação ao comportamento atual -->

## Possível Solução
<!--- Não é obrigatório, mas sugira uma correção/razão para o bug, -->
<!--- ou ideias de como implementar: a adição ou mudança -->

## Etapas para Reproduzir (para bugs)
<!--- Forneça um link para um exemplo ao vivo, ou um conjunto inequívoco de etapas para -->
<!--- reproduzir este bug. Inclua configuração, logs, etc. para reproduzir, se relevante -->
1.
2.
3.
4.

## Contexto
<!--- Como este problema afetou você? O que você está tentando realizar? -->
<!--- Fornecer contexto nos ajuda a chegar a uma solução que seja mais útil no mundo real -->

## Seu Ambiente
<!--- Inclua tantos detalhes relevantes sobre o ambiente em que você experimentou o problema -->
* Versão usada (Admin - Painel):
* Plugins habilitados (Admin - Plugins):
* Nome e versão do navegador:
* Erros nas ferramentas de desenvolvedor:
2 curtidas
2

Topic templates aren’t particularly effective in my experience – they are certainly no magic bullet. The type of people you would want to read them, rarely do, and for those that know what they are doing, they get in the way.

I would only do this if there are certain very mandatory things you need in each topic, like serial number or something.

3 curtidas
3

Hi,

I get your point, the many who feel disturbed by such a template will just ctrl+a&del the content. I do that sometimes as well, when the structure doesn‘t fit.

I know too little about this community til now. From reading threads I‘d say you do not really need it, as this platform has a totally different conversation “flow” and is more a chat than issue discussions. I love to hear what others think, and won‘t be sad if you do not apply it :slight_smile:

Still, I hope such a template helps others who might have been looking into the same for their setup. It took me quite a while to find the perfect template for github, you likely have only one shot amongst established readers :wink:

Cheers,
Michael