Resumo
Este tópico de documentação aborda como escrever uma solicitação de recurso no Discourse: Um Guia Passo a Passo.
Passo 1: Antes de Começar
Então, você tem uma ótima ideia para um recurso do Discourse? Isso é fantástico! Aqui está como você pode compartilhá-la com a equipe e a comunidade de forma eficaz. Antes de enviar uma solicitação de recurso, reserve um momento para pesquisar nas discussões existentes para ver se sua ideia já foi sugerida ou implementada. Você pode fazer isso de algumas maneiras:
- Procurando na categoria Contribute > 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. - Navegando pelos tópicos com as tags pr-welcome - Uma PR (Pull Request) é uma solicitação de pull no GitHub - uma maneira para desenvolvedores introduzirem novo código em um projeto.
- Navegando pelos tópicos com a tag completed
- Procurando nas categorias Customization > Plugin e Customization > Theme component
Se a sua sugestão de recurso já estiver listada, você pode apoiá-la votando nela para tornar a solicitação mais proeminente, curtindo-a e respondendo com ideias ou casos de uso adicionais, para comunicar melhor sua utilidade e o motivo pelo qual o recurso deve ser adicionado.
Não encontrou nenhuma menção à sua ideia? Você pode criar uma solicitação de recurso.
Passo 2: Os fundamentos
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 Contribute > Feature.
Tag
As tags são usadas para agrupar e classificar os recursos. Portanto, para manter as solicitações organizadas, etiquetar seu tópico de forma adequada é muito útil para fins de acompanhamento. 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 recurso é importante, pois ajuda a equipe do Discourse a identificar rapidamente áreas que podem precisar de melhoria.
Lembre-se, ao criar uma solicitação de recurso, você está tentando apresentar sua ideia e convencer as pessoas de que sua sugestão de recurso é bem fundamentada. Explique por que você deseja que seu recurso seja adicionado: para a comunidade, para você mesmo e para a Equipe.
No corpo do seu tópico, declare de forma concisa o recurso que 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 recurso.
- Uma descrição clara do recurso que você está solicitando
- Inclua o problema ou os casos de uso de sua dificuldade atual e como seu recurso a resolveria
- Qualquer informação relevante de fundo ou pesquisa 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 recurso, para que outros possam visualizar facilmente sua ideia.
Engaje-se com a Comunidade
Depois de criar sua solicitação de recurso, interaja com os membros respondendo a perguntas e feedbacks. Isso aumentará as chances de sua solicitação ser considerada.
O que Esperar a Seguir
Após enviar sua solicitação de recurso, 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á sendo considerada
- Possível implementação do seu recurso em uma atualização futura
Quer garantir que seu recurso seja criado?
Em alguns casos, as solicitações de recurso podem não ser adequadas para o núcleo (core). Você pode ler como as decisões sobre recursos são tomadas. Se você não conseguir desenvolver o recurso por conta própria, ainda há maneiras de aumentar as chances de que ele seja criado.
Torne-se um cliente da discourse.org
Se você deseja financiar o desenvolvimento hospedando sites conosco – sempre priorizamos solicitações de clientes em nosso cronograma de desenvolvimento – essa é uma maneira de conseguir que ele seja implementado mais rapidamente. Clientes Enterprise podem solicitar recursos personalizados (geralmente na forma de um plugin) para a equipe principal por uma taxa horária.
Patrocine uma tarefa “pr-welcome”
Temos uma lista abrangente de tópicos pr-welcome. Estas são tarefas que gostaríamos de ver concluídas, mas atualmente não temos capacidade 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ê precisa e que é crítico para o seu negócio, anuncie um trabalho pago 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 microserviços padronizados como “instalação única” ou “tema personalizado.”
Geral
Boas e más práticas gerais
Faça
- Mantenha sua solicitação concisa e focada em um único recurso
- Evite fazer suposições sobre a implementação ou detalhes técnicos
- Demonstre disposição para compromissos e adaptação de sua ideia com base no feedback da comunidade
Não faça
- Inclua mais de um recurso por tópico
- Deixe outros questionando o escopo da sua solicitação
Perguntas Frequentes (FAQs)
P: E se eu não tiver tempo para criar uma solicitação de recurso detalhada?
R: Se no momento você não conseguir criar uma solicitação detalhada, pense sobre o que deseja dizer e tente novamente mais tarde. Isso garante que você apresente o melhor argumento possível, resultando em maior chance de que outros apoiem sua solicitação e ela seja adicionada.
P: Onde devo postar minha solicitação de recurso?
R: Use a categoria apropriada – as solicitações de recurso devem ir para a categoria #feature::category.
P: E se eu não tiver certeza de qual tag usar para minha solicitação?
R: Embora as tags correspondam aos nomes dos plugins e componentes de tema para facilitar o uso, um membro da Equipe ou um Usuário Regular adicionará uma tag apropriada ao seu tópico se ele for deixado em branco.
Seja respeitoso e aberto em sua solicitação. Evite usar a solicitação de recurso para expressar frustração. Qualquer linguagem ou comportamento inadequado pode resultar no atraso ou ignorância da sua solicitação.
Recursos Adicionais
- Categorias: Contribute > Feature, Marketplace, Customization > Plugin, Customization > Extras, Customization > Theme, Customization > 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
