Escribir una solicitud de función efectiva, una guía paso a paso

Resumen

Este tema de documentación cubre cómo escribir una solicitud de características en Discourse: Una guía paso a paso.

Paso 1: Antes de empezar

¿Tienes una gran idea para una característica de Discourse? ¡Eso es fantástico! Aquí te mostramos cómo puedes compartirla de manera efectiva con el equipo y la comunidad. Antes de enviar una solicitud de características, tómate un momento para buscar en las discusiones existentes y ver si tu idea ya ha sido sugerida o implementada. Puedes hacerlo de un par de maneras:

  • Buscando en la categoría Feature
  • Haciendo clic en el icono :mag: en la esquina superior derecha de la página para abrir la búsqueda. Puedes usar filtros avanzados para filtrar por categoría y etiqueta.
  • Buscando temas con las etiquetas pr-welcome - Un PR es una solicitud de extracción en GitHub, una forma para que los desarrolladores introduzcan nuevo código en un proyecto.
  • Buscando temas con la etiqueta completed
  • Buscando en la categoría Plugin

Si tu sugerencia de característica ya está listada, puedes apoyarla votando por ella para hacer que sus solicitudes sean más prominentes, dándole “me gusta” y respondiendo con ideas adicionales o casos de uso, para comunicar aún más su utilidad y por qué la característica debería añadirse.

¿No encuentras ninguna mención de tu idea? Puedes crear una solicitud de características.

Paso 2: Lo básico

Título
Es importante que los títulos de los temas sean informativos, pero al mismo tiempo no demasiado largos. El alcance de la solicitud debe ser fácilmente identificable de un vistazo.

Categoría
Al crear un nuevo tema, por favor selecciona la categoría Feature.

Etiqueta
Las etiquetas se utilizan para agrupar y clasificar características, por lo tanto, para mantener las solicitudes organizadas, etiquetar tu tema de manera apropiada es muy útil para fines de seguimiento. Por ejemplo, todo lo relacionado con el plugin chat se mantiene junto bajo una etiqueta.


Paso 3: Escribiendo tu solicitud

Escribir una buena solicitud de características es importante, ayuda al equipo de Discourse a identificar rápidamente las áreas que podrían necesitar mejoras.

Recuerda, al crear una solicitud de características, estás tratando de presentar tu idea y convencer a la gente de que tu idea para una característica está bien fundamentada. Explica por qué quieres que tu característica se añada a: la comunidad, a ti mismo y al equipo.

En el cuerpo de tu tema, indica de forma concisa la característica que estás solicitando. Sé específico y descriptivo, evita ser vago o de final abierto.

Proporciona contexto y explicación

Proporciona contexto y explicación para tu solicitud de características.

  • Una descripción clara de la característica que estás solicitando
  • Incluye el problema o los casos de uso de tu lucha actual y cómo tu característica lo resolvería
  • Cualquier información de fondo relevante o investigación que hayas realizado

Proporciona ejemplos y capturas de pantalla (Opcional)

Si es aplicable, proporciona ejemplos, maquetas o capturas de pantalla para ayudar a ilustrar tu solicitud de características para que otros puedan visualizar fácilmente tu idea.

Interactúa con la comunidad

Una vez que hayas creado tu solicitud de características, interactúa con los miembros respondiendo a preguntas y comentarios. Esto ayudará a aumentar las posibilidades de que tu solicitud sea considerada.

Qué esperar a continuación

Después de enviar tu solicitud de características, será revisada por la comunidad y el equipo de Discourse. Puedes esperar:

  • Comentarios y discusiones de la comunidad
  • Una respuesta del personal de Discourse indicando si tu solicitud es factible y está bajo consideración
  • Posible implementación de tu solicitud de características en una futura actualización

¿Quieres asegurarte de que tu característica se haga?

En algunos casos, las solicitudes de características pueden no ser adecuadas para el núcleo. Puedes leer cómo se toman las decisiones sobre las características. Si no puedes desarrollar la característica tú mismo, todavía hay maneras de aumentar las posibilidades de que se haga.

Conviértete en un cliente de discourse.org

Si deseas financiar el desarrollo alojando sitios con nosotros, siempre priorizamos las solicitudes de los clientes en nuestro cronograma de desarrollo, esa es una forma de hacerlo más rápido. Los clientes empresariales pueden solicitar características personalizadas (generalmente en forma de plugin) al equipo principal a una tarifa por hora.

Patrocina una tarea “pr-welcome”

Tenemos una lista completa de temas pr-welcome. Estas son tareas que nos encantaría ver completadas, pero actualmente no tenemos el ancho de banda para trabajar en ellas. Patrocinar a alguien para que trabaje en estas tareas es una excelente manera de involucrarse y cualquier contribución a Discourse es muy apreciada.

Ofrece trabajo remunerado en el Marketplace

Si hay un plugin que necesitas y que es crítico para tu negocio, anuncia una asignación pagada en la categoría Marketplace. Proporciona tantos detalles como sea posible, incluyendo capturas de pantalla y presupuesto. También puedes encontrar freelancers que ofrecen microservicios estandarizados como “instalación única” o “tema personalizado”.

General

Reglas generales de lo que se debe y no se debe hacer

Hacer

  • Mantén tu solicitud concisa y centrada en una sola característica
  • Evita hacer suposiciones sobre la implementación o los detalles técnicos
  • Muestra disposición a comprometerte y adaptar tu idea basándote en los comentarios de la comunidad

No hacer

  • Incluir más de una característica por tema
  • Dejar a otros preguntándose sobre el alcance de tu solicitud

Preguntas frecuentes

P: ¿Qué pasa si no tengo tiempo para crear una solicitud de características detallada?
R: Si en el momento no puedes crear una solicitud detallada, piensa en lo que quieres decir y vuelve a intentarlo más tarde. Esto asegura que presentes tu mejor argumento, lo que resulta en una mayor probabilidad de que otros apoyen tu solicitud y de que se añada.

P: ¿Dónde debo publicar mi solicitud de características?
R: Usa la categoría apropiada: las solicitudes de características deben ir en la categoría Feature.

P: ¿Qué pasa si no estoy seguro de qué etiqueta usar para mi solicitud?
R: Aunque las etiquetas coinciden con los nombres de los plugins y componentes de temas para facilitar su uso, un miembro del equipo o un Regular adjuntará una etiqueta apropiada a tu tema si se deja en blanco.

Sé respetuoso y de mente abierta en tu solicitud. Evita usar la solicitud de características para expresar frustración. Cualquier lenguaje o comportamiento inapropiado puede resultar en que tu solicitud se retrase o se ignore.

Recursos adicionales

13 Me gusta

¿Significa esto que puedo esperar respuestas del personal sobre mis solicitudes de funciones pendientes? :innocent: :sweat_smile: :smiley:

2 Me gusta

Lo escribí porque, cuando eché un vistazo rápido a las funciones, la mayoría de los temas tienen una respuesta de un miembro del equipo. Me gustan tus solicitudes de funciones :smile:

2 Me gusta

Creo que esta es una de las cosas más importantes, y a menudo no se le da suficiente énfasis:

Es realmente útil tener la mayor comprensión posible de esto, en términos lo más concretos posible.

Cuando otros intervienen en las solicitudes de funciones de otros, esta es también la parte que suelo buscar, ya que diferentes personas a menudo tienen problemas ligeramente diferentes.

Además, saber cómo las personas resuelven actualmente ese problema también es muy útil (por ejemplo, cuál es tu solución alternativa o solución alternativa actual al problema).

5 Me gusta