Resumo
Este tópico de documentação aborda como escrever uma solicitação de funcionalidade no Discourse: Um Guia Passo a Passo.
Passo 1: Antes de Começar
Então, você tem uma ótima ideia para uma funcionalidade no Discourse? Isso é fantástico! Veja como você pode compartilhá-la com a equipe e a comunidade de forma eficaz. Antes de enviar uma solicitação de funcionalidade, por favor, reserve um momento para pesquisar discussões existentes para ver se sua ideia já foi sugerida ou implementada. Você pode fazer isso de algumas maneiras:
- Procurando na categoria Feature
- Clicando no ícone
no canto superior direito da página para abrir a pesquisa. Você pode usar filtros avançados para filtrar por categoria e tag. - Procurando tópicos com a tag pr-welcome - Um PR é um pull request no GitHub - uma maneira de os desenvolvedores introduzirem novo código em um projeto.
- Procurando tópicos com a tag completed
- Procurando nas categorias Plugin e Theme component
Se a sua sugestão de funcionalidade já estiver listada, você pode apoiá-la votando nela para tornar as solicitações mais proeminentes, curtindo-a e respondendo com ideias adicionais ou casos de uso, para comunicar melhor sua utilidade e por que a funcionalidade deve ser adicionada.
Não consegue encontrar nenhuma menção à sua ideia? Você pode criar uma solicitação de funcionalidade.
Passo 2: O Básico
Título
É importante que os títulos dos tópicos sejam informativos, mas ao mesmo tempo não muito longos. O escopo da solicitação deve ser facilmente identificável à primeira vista.
Categoria
Ao criar um novo tópico, selecione a categoria Feature.
Tag
As tags são usadas para agrupar e classificar funcionalidades, portanto, para manter as solicitações organizadas, taguear seu tópico apropriadamente é muito útil para fins de rastreamento. Por exemplo, tudo relacionado ao plugin chat é mantido junto sob uma única tag.
Passo 3: Escrevendo sua Solicitação
Escrever uma boa solicitação de funcionalidade é importante, ajuda a equipe do Discourse a identificar rapidamente áreas que podem precisar de melhoria.
Lembre-se, ao criar uma solicitação de funcionalidade, você está tentando apresentar sua ideia e convencer as pessoas de que sua ideia para uma funcionalidade é bem fundamentada. Explique por que você quer que sua funcionalidade seja adicionada: para a comunidade, para você e para a Equipe.
No corpo do seu tópico, declare concisamente a funcionalidade que você está solicitando. Seja específico e descritivo, evite ser vago ou aberto.
Forneça Contexto e Explicação
Forneça contexto e explicação para sua solicitação de funcionalidade.
- Uma descrição clara da funcionalidade que você está solicitando
- Inclua o problema ou casos de uso da sua dificuldade atual e como sua funcionalidade o resolveria
- Qualquer informação de fundo ou pesquisa relevante que você tenha feito
Forneça Exemplos e Capturas de Tela (Opcional)
Se aplicável, forneça exemplos, maquetes ou capturas de tela para ajudar a ilustrar sua solicitação de funcionalidade para que outros possam visualizar facilmente sua ideia.
Envolva-se com a Comunidade
Depois de criar sua solicitação de funcionalidade, interaja com os membros respondendo a perguntas e feedback. Isso aumentará as chances de sua solicitação ser considerada.
O Que Esperar em Seguida
Após enviar sua solicitação de funcionalidade, ela será revisada pela comunidade e pela Equipe do Discourse. Você pode esperar:
- Feedback e discussão da comunidade
- Uma resposta da equipe do Discourse indicando se sua solicitação é viável e está em consideração
- Potencial implementação de sua solicitação de funcionalidade em uma atualização futura
Quer garantir que sua funcionalidade seja implementada?
Em alguns casos, as solicitações de funcionalidade podem não ser adequadas para o núcleo. Você pode ler como as decisões de funcionalidades são tomadas. Se você não conseguir desenvolver a funcionalidade, ainda há maneiras de aumentar as chances de ela ser implementada.
Torne-se um cliente discourse.org
Se você gostaria de financiar o desenvolvimento hospedando sites conosco – sempre priorizamos as solicitações dos clientes em nosso cronograma de desenvolvimento – essa é uma maneira de implementá-la mais rapidamente. Clientes Enterprise podem solicitar funcionalidades personalizadas (geralmente na forma de um plugin) pela equipe principal a uma taxa horária.
Patrocine uma tarefa “pr-welcome”
Temos uma lista abrangente de tópicos pr-welcome. Estas são tarefas que adoraríamos ver concluídas, mas atualmente não temos largura de banda para trabalhar nelas. Patrocinar alguém para trabalhar nessas tarefas é uma ótima maneira de se envolver e qualquer contribuição para o Discourse é muito apreciada.
Ofereça trabalho pago no Marketplace
Se houver um plugin que você precise e que seja fundamental para o seu negócio, anuncie uma tarefa paga na categoria Marketplace. Forneça o máximo de detalhes possível, incluindo capturas de tela e orçamento. Você também pode encontrar freelancers oferecendo microsserviços padronizados como “instalação única” ou “tema personalizado”.
Geral
O que fazer e o que não fazer
Fazer
- Mantenha sua solicitação concisa e focada em uma única funcionalidade
- Evite fazer suposições sobre implementação ou detalhes técnicos
- Demonstre disposição para comprometer e adaptar sua ideia com base no feedback da comunidade
Não fazer
- Incluir mais de uma funcionalidade por tópico
- Deixar os outros em dúvida sobre o escopo da sua solicitação
FAQs
P: E se eu não tiver tempo para criar uma solicitação de funcionalidade detalhada?
R: Se no momento você não puder criar uma solicitação detalhada, pense sobre o que você quer dizer e tente novamente mais tarde. Isso garante que você apresente seu melhor argumento, resultando em uma chance maior de que outros apoiem sua solicitação e ela seja adicionada.
P: Onde devo postar minha solicitação de funcionalidade?
R: Use a categoria apropriada - solicitações de funcionalidade devem ir para a categoria Feature.
P: E se eu não tiver certeza de qual tag usar para minha solicitação?
R: Embora as tags correspondam aos nomes de plugins e componentes de tema para facilitar o uso, um membro da Equipe ou um Regular anexará uma tag apropriada ao seu tópico se ela for deixada em branco.
Seja respeitoso e de mente aberta em sua solicitação. Evite usar a solicitação de funcionalidade para expressar frustração. Qualquer linguagem ou comportamento inadequado pode resultar no atraso ou ignorância de sua solicitação.
Recursos Adicionais
- Categorias: Feature, Marketplace, Plugin, Plugin > Extras, Theme, Theme component
- Tags: current-projects, release-notes, pr-welcome, planned
- https://meta.stackexchange.com/questions/258136/how-do-i-write-a-good-feature-request
- How do we decide what goes into each release of Discourse?
- Discourse pricing | Discourse - Civilized Discussion
