Resumo
Este tópico de documentação abrange 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! Veja como você pode compartilhá-la com a equipe e a comunidade de forma eficaz. Antes de enviar uma solicitação de recurso, 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 as tags pr-welcome - Um PR é um pull request no GitHub - uma maneira para os desenvolvedores introduzirem novo código em um projeto.
- Procurando tópicos com a tag completed
- Procurando na categoria Plugin
Se sua sugestão de recurso já estiver listada, você pode apoiá-la votando nela para tornar suas solicitações mais proeminentes, curtindo-a e respondendo com ideias adicionais ou casos de uso, para comunicar ainda mais sua utilidade e por que o recurso deve ser adicionado.
Não encontrou nenhuma menção da sua ideia? Você pode criar uma solicitação de recurso.
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 rapidamente.
Categoria
Ao criar um novo tópico, por favor, selecione a categoria Feature.
Tag
As tags são usadas para agrupar e classificar recursos, portanto, para manter as solicitações organizadas, marcar 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 recurso é importante, pois ajuda a equipe do Discourse a identificar rapidamente áreas que podem precisar de melhorias.
Lembre-se, ao criar uma solicitação de recurso, você está tentando apresentar sua ideia e convencer as pessoas de que sua ideia para um recurso é bem fundamentada. Explique por que você quer que seu recurso seja adicionado: para a comunidade, para você mesmo e para a Equipe.
No corpo do seu tópico, declare concisamente o recurso 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 recurso.
- Uma descrição clara do recurso que você está solicitando
- Inclua o problema ou casos de uso de sua dificuldade atual e como seu recurso o resolveria
- Qualquer informação de fundo relevante 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 feedback. 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á sob consideração
- Potencial implementação de sua solicitação de recurso em uma atualização futura
Quer garantir que seu recurso seja feito?
Em alguns casos, as solicitações de recursos podem não ser adequadas para o núcleo. Você pode ler como as decisões de recursos são tomadas. Se você não puder desenvolver o recurso você mesmo, ainda há maneiras de aumentar as chances de ele ser feito.
Torne-se um cliente discourse.org
Se você gostaria de financiar o desenvolvimento hospedando sites conosco – sempre priorizamos as solicitações de clientes em nossa linha do tempo de desenvolvimento – essa é uma maneira de implementá-lo mais rapidamente. Clientes empresariais podem solicitar recursos personalizados (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ê precisa e que seja crítico para seus negócios, anuncie uma tarefa paga no 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
Do’s e Don’ts gerais
Faça
- Mantenha sua solicitação concisa e focada em um único recurso
- Evite fazer suposições sobre implementação ou detalhes técnicos
- Mostre disposição para comprometer e adaptar sua ideia com base no feedback da comunidade
Não faça
- Inclua mais de um recurso por tópico
- Deixe os outros questionando o escopo da sua solicitação
FAQs
P: E se eu não tiver tempo para criar uma solicitação de recurso 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 recurso?
R: Use a categoria apropriada - as solicitações de recursos 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 temas para facilitar o uso, um membro da Equipe ou um Regular anexará uma tag apropriada ao seu tópico se ele for deixado em branco.
Seja respeitoso e de mente aberta 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 de sua solicitação.
Recursos Adicionais
- Feature - Discourse Meta
- Plugin - Discourse Meta
- 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
- Marketplace - Discourse Meta
- https://meta.discourse.org/c/releases
- Upcoming feature to-do list
- Tópicos com a tag planned
- Extras - Discourse Meta
