Lorawan-stack: Modelo de problema para perguntas

Criado em 1 jul. 2019  ·  9Comentários  ·  Fonte: TheThingsNetwork/lorawan-stack

Resumo

Proponho adicionar um modelo de problema para perguntas.

Por que nós precisamos disso?

Em #871 e #873, vemos que os modelos de problemas atuais não são aplicáveis ​​a perguntas.

O que já existe? O que você vê agora?

Temos modelos de problemas para bugs e recursos. Não temos um modelo de problema para perguntas, mas também não aceitamos problemas que não seguem um modelo de problema.

O que está faltando? O que você quer ver?

Acho que seria bom criar um modelo de problema para perguntas. Este modelo pode conter uma lista de verificação de outros lugares para procurar primeiro

Como você se propõe a implementar isso?

  • Resumo
  • Por que você está fazendo essa pergunta?
  • Passos para reproduzir / Passos que você deu

    • [ ] Você pesquisou a documentação?

    • [ ] Você pesquisou no fórum?

    • [ ] Você pesquisou problemas existentes?

  • O que já existe? O que dizia a documentação/fórum/questão?
  • O que está faltando para responder sua pergunta?
  • ...

Você pode fazer isso sozinho e enviar um Pull Request?

Vamos discutir primeiro

documentation in progress

Comentários muito úteis

Exatamente. O resultado de um problema de "pergunta" geralmente deve ser uma alteração em nossa documentação ou uma adição ao nosso FAQ.

Não sei se faz sentido copiar e colar um problema de "pergunta" em um problema de "bug_report". Talvez devêssemos apenas adicionar as seções relevantes nos comentários (ou editar o problema) se decidirmos transformar uma pergunta em um relatório de bug ou recurso.

Todos 9 comentários

então a "ação" seria atualizar a documentação diretamente (se essa for a única alteração) referenciando esse problema e abrir outro se isso resultar em uma correção de bug/solicitação de recurso?

Exatamente. O resultado de um problema de "pergunta" geralmente deve ser uma alteração em nossa documentação ou uma adição ao nosso FAQ.

Não sei se faz sentido copiar e colar um problema de "pergunta" em um problema de "bug_report". Talvez devêssemos apenas adicionar as seções relevantes nos comentários (ou editar o problema) se decidirmos transformar uma pergunta em um relatório de bug ou recurso.

Concordo, mas isso também deve se aplicar ao fórum e ao slack.

Em essência, todas as informações devem estar na documentação do repositório, se alguma informação for referência no fórum, problemas ou slack, falhamos em fazer uma documentação.
Pergunta ou problema levantado no slack, o fórum deve compensar a alteração no documento, a menos que nenhum esforço tenha sido feito para procurar as informações.

Em vez de ter uma lista de "você olhou lá", eu adicionaria um link para uma consulta no github / doc (uma vez que a pesquisa é impl) . Procurar informações em problemas do github pode ser tedioso e o fórum não deve conter informações/explicações que o documento não possui. Um link para uma consulta já estabelecida (como procurar bugs) ajudará. A adição de uma seção de bugs conhecidos aos documentos também pode ser considerada.

Se uma pergunta esclarecer um bug, cabe ao desenvolvedor qualificá-lo como um bug (e editar o problema como um relatório de bug) ou abrir outro problema se a única parte da pergunta envolver um bug.

Concordo plenamente que devemos monitorar melhor o Fórum e o Slack e transformar (boas) perguntas em melhorias de documentação (pelo menos para a categoria v3 e canal lorawan-stack ). @Sypheos como você veria isso funcionando na prática?

O objetivo do "você olhou aqui" era mais um filtro para as pessoas que enviavam problemas antes de fazer qualquer pesquisa. A próxima seção é mais útil, onde podemos pedir ao remetente do problema para vincular (ou citar) postagens relevantes do fórum, mensagens de folga etc.

Eu acho que isso é uma boa idéia. Vamos manter o escopo deste problema e o modelo de problema realmente uma nova questão.

Quanto às melhorias na documentação, ou seja, respostas informais em um fórum e no Slack de que queremos fazer parte da documentação, podemos considerar um modelo de problema de "solicitação de documentação" adicional, que é mínimo; ele basicamente descreve a lacuna de documentação e o link para onde a informação está agora, se houver (ou seja, um link para o fórum/mensagem do Slack). Mas, novamente, para mim, fora do escopo para esta questão.

Para o modelo de pergunta imo:
O que está procurando/fazendo?
Onde você olhou?
_Adicione qualquer página da web, problemas, consultas no github, os documentos, fórum são bem-vindos_
Por que não foi satisfatório?
_404 não encontrado é uma resposta legítima_

Marcador: pergunta

se não houver recursos para responder a pergunta, abra um problema de "solicitação de documentação".

Devemos realmente garantir que todas as respostas acabem na documentação, caso contrário, os problemas encerrados aqui se tornam a base de conhecimento da V3, e devemos evitar isso. Então talvez devêssemos pular o modelo "pergunta" e ir diretamente para "solicitação de documentação".

Além disso, quando o uso deste repositório cresce, e isso acaba sendo o local ideal para fazer perguntas e temos dificuldade em moderar isso (ou seja, apontando para documentos e fechando problemas), podemos nos arrepender disso no futuro. Observe que repositórios maiores, como o VS Code, comunicam que você não deve fazer perguntas de forma bastante agressiva:

Screenshot 2019-07-01 at 17 50 45

Screenshot 2019-07-01 at 17 50 54

Em suma, vamos considerar;

  • Não permite perguntas, apenas questões de "solicitação de documentação". As perguntas ainda são válidas, mas apenas se realmente não estiverem documentadas, caso contrário, não é uma solicitação de documentação válida e a fechamos
  • Perguntas diretas para os documentos (quando os temos) e fóruns

Os pedidos de documentação são, na verdade, "Perguntas", pois estavam procurando algo, mas não conseguiram encontrá-lo. No início, eles têm uma pergunta que precisa de uma resposta.
Para ir nessa direção, faria mais sentido simplesmente negar qualquer solicitação de documentação e perguntas por meio de problemas no github.

Se alguém quiser fazer uma pergunta, deve ir ao slack ou ao fórum onde alguém da equipe principal ou da moderação pode transformar sua pergunta em um problema de PR / problema de bug / solicitação de recurso de documentação.

Decisão: vamos com https://github.com/TheThingsNetwork/lorawan-stack/issues/890#issuecomment -507324845. Modelo de pergunta que direciona para o fórum e um modelo de solicitação de documentação

Esta página foi útil?
0 / 5 - 0 avaliações

Questões relacionadas

kschiffer picture kschiffer  ·  4Comentários

ecities picture ecities  ·  5Comentários

kschiffer picture kschiffer  ·  7Comentários

adriansmares picture adriansmares  ·  9Comentários

MatteMoveSRL picture MatteMoveSRL  ·  7Comentários