Resumen
Este tema de documentación cubre cómo redactar una solicitud de función en Discourse: una guía paso a paso.
Paso 1: Antes de comenzar
¿Tienes una gran idea para una función de Discourse? ¡Es fantástico! Así es como puedes compartirla con el equipo y la comunidad de manera efectiva. Antes de enviar una solicitud de función, tómate un momento para buscar en las discusiones existentes y ver si tu idea ya ha sido sugerida o implementada. Puedes hacerlo de varias formas:
- Buscando en la categoría Contribute > Feature
- Haciendo clic en el icono
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. - Revisando los temas con las etiquetas pr-welcome - Un PR es una solicitud de extracción (pull request) en GitHub, una forma en que los desarrolladores introducen nuevo código en un proyecto.
- Revisando los temas con la etiqueta completed
- Buscando en las categorías Customization > Plugin y Customization > Theme component
Si tu sugerencia de función ya está listada, puedes apoyarla votando a favor para que sus solicitudes sean más prominentes, dándole «me gusta» y respondiendo con ideas o casos de uso adicionales, para comunicar mejor su utilidad y por qué debería agregarse la función.
¿No encuentras ninguna mención de tu idea? Puedes crear una solicitud de función.
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, selecciona la categoría Contribute > Feature.
Etiqueta
Las etiquetas se utilizan para agrupar y clasificar las funciones; por lo tanto, para mantener las solicitudes organizadas, etiquetar tu tema de manera apropiada es muy útil para el seguimiento. Por ejemplo, todo lo relacionado con el plugin chat se mantiene junto bajo una sola etiqueta.
Paso 3: Escribir tu solicitud
Escribir una buena solicitud de función es importante, ayuda al equipo de Discourse a identificar rápidamente las áreas que podrían necesitar mejoras.
Recuerda que, al crear una solicitud de función, estás tratando de presentar tu idea y convencer a las personas de que tu idea para una función está bien fundamentada. Explica por qué quieres que tu función se agregue: para la comunidad, para ti mismo y para el Equipo.
En el cuerpo de tu tema, declara de manera concisa la función que estás solicitando. Sé específico y descriptivo, evita ser vago o abierto.
Proporciona contexto y explicación
Proporciona contexto y explicación para tu solicitud de función.
- Una descripción clara de la función que estás solicitando
- Incluye el problema o los casos de uso de tu situación actual y cómo tu función la 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 función, de modo que otros puedan visualizar fácilmente tu idea.
Interactúa con la comunidad
Una vez que hayas creado tu solicitud de función, 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 función, 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 viable y está siendo considerada
- La posible implementación de tu solicitud de función en una actualización futura
¿Quieres asegurarte de que tu función se implemente?
En algunos casos, las solicitudes de funciones pueden no ser adecuadas para el núcleo (core). Puedes leer cómo se toman las decisiones sobre las funciones. Si no puedes desarrollar la función tú mismo, todavía hay formas de aumentar las posibilidades de que se implemente.
Conviértete en 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 obtenerlo más rápido. Los clientes empresariales pueden solicitar funciones personalizadas (generalmente en forma de un 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 tiempo para trabajar en ellas nosotros mismos. 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 Mercado
Si hay un plugin que necesitas y es crítico para tu negocio, anuncia una tarea remunerada en la categoría Marketplace. Proporciona tantos detalles como sea posible, incluyendo capturas de pantalla y presupuesto. También podrías encontrar freelancers que ofrezcan microservicios estandarizados como «instalación única» o «tema personalizado».
General
Buenas y malas prácticas generales
Hacer
- Mantén tu solicitud concisa y centrada en una sola función
- Evita hacer suposiciones sobre la implementación o los detalles técnicos
- Muestra disposición para comprometerte y adaptar tu idea según los comentarios de la comunidad
No hacer
- Incluir más de una función por tema
- Dejar a otros cuestionando el alcance de tu solicitud
Preguntas frecuentes
P: ¿Qué pasa si no tengo tiempo para crear una solicitud de función detallada?
R: Si en el momento no puedes crear una solicitud detallada, piensa en lo que quieres decir e inténtalo de nuevo más tarde. Esto asegura que presentes tu mejor caso, lo que aumenta la probabilidad de que otros apoyen tu solicitud y esta se agregue.
P: ¿Dónde debo publicar mi solicitud de función?
R: Usa la categoría apropiada: las solicitudes de funciones deben publicarse en la categoría #feature::category.
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 tema para facilitar el uso, un miembro del Equipo o un Usuario Regular añadirá una etiqueta apropiada a tu tema si se deja en blanco.
Sé respetuoso y abierto en tu solicitud. Evita usar la solicitud de función para expresar frustración. Cualquier lenguaje o comportamiento inapropiado puede resultar en que tu solicitud se retrase o se ignore.
Recursos adicionales
- Categorías: Contribute > Feature, Marketplace, Customization > Plugin, Customization > Extras, Customization > Theme, Customization > Theme component
- Etiquetas: 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
