Résumé
Ce sujet de documentation couvre la rédaction d’une demande de fonctionnalité sur Discourse : un guide étape par étape.
Étape 1 : Avant de commencer
Vous avez une excellente idée pour une fonctionnalité de Discourse ? C’est formidable ! Voici comment la partager efficacement avec l’équipe et la communauté. Avant de soumettre une demande de fonctionnalité, veuillez prendre un moment pour rechercher les discussions existantes afin de voir si votre idée a déjà été suggérée ou implémentée. Vous pouvez le faire de plusieurs façons :
- En consultant la catégorie Contribute > Feature
- En cliquant sur l’icône
dans le coin supérieur droit de la page pour accéder à la recherche. Vous pouvez utiliser des filtres avancés pour filtrer par catégorie et par étiquette. - En parcourant les sujets portant les étiquettes pr-welcome - Un PR (Pull Request) est une demande de fusion sur GitHub, un moyen pour les développeurs d’introduire du nouveau code dans un projet.
- En parcourant les sujets portant l’étiquette completed
- En consultant les catégories Customization > Plugin et Customization > Theme component
Si votre suggestion de fonctionnalité est déjà listée, vous pouvez la soutenir en votant pour elle afin de rendre cette demande plus visible, en la likant et en répondant avec des idées ou des cas d’utilisation supplémentaires, afin de mieux communiquer son utilité et pourquoi la fonctionnalité devrait être ajoutée.
Vous ne trouvez aucune mention de votre idée ? Vous pouvez créer une demande de fonctionnalité.
Étape 2 : Les bases
Titre
Il est important que les titres des sujets soient informatifs, mais sans être trop longs. L’étendue de la demande doit être identifiable d’un simple coup d’œil.
Catégorie
Lors de la création d’un nouveau sujet, veuillez sélectionner la catégorie Contribute > Feature.
Étiquette
Les étiquettes sont utilisées pour regrouper et classifier les fonctionnalités. Par conséquent, pour maintenir l’organisation des demandes, étiqueter correctement votre sujet est très utile pour le suivi. Par exemple, tout ce qui concerne le plugin chat est regroupé sous une seule étiquette.
Étape 3 : Rédiger votre demande
Rédiger une bonne demande de fonctionnalité est important, cela aide l’équipe de Discourse à identifier rapidement les domaines qui pourraient nécessiter des améliorations.
Rappelez-vous, lors de la création d’une demande de fonctionnalité, vous tentez de présenter votre idée et de convaincre les gens que votre idée est bien fondée. Expliquez pourquoi vous souhaitez que votre fonctionnalité soit ajoutée : pour la communauté, pour vous-même et pour l’équipe.
Dans le corps de votre sujet, énoncez brièvement la fonctionnalité que vous demandez. Soyez spécifique et descriptif, évitez d’être vague ou ouvert à l’interprétation.
Fournissez du contexte et des explications
Fournissez du contexte et des explications pour votre demande de fonctionnalité.
- Une description claire de la fonctionnalité que vous demandez
- Incluez le problème ou les cas d’utilisation liés à vos difficultés actuelles et comment votre fonctionnalité les résoudrait
- Toutes informations contextuelles pertinentes ou recherches que vous avez effectuées
Fournissez des exemples et des captures d’écran (Facultatif)
Si cela s’applique, fournissez des exemples, des maquettes ou des captures d’écran pour aider à illustrer votre demande de fonctionnalité, afin que d’autres puissent facilement visualiser votre idée.
Engagez-vous avec la communauté
Une fois que vous avez créé votre demande de fonctionnalité, engagez-vous avec les membres en répondant aux questions et aux commentaires. Cela augmentera les chances que votre demande soit prise en compte.
À quoi vous attendre ensuite
Après avoir soumis votre demande de fonctionnalité, elle sera examinée par la communauté et l’équipe de Discourse. Vous pouvez vous attendre à :
- Des commentaires et des discussions de la communauté
- Une réponse du personnel de Discourse indiquant si votre demande est réalisable et à l’étude
- Une éventuelle implémentation de votre demande de fonctionnalité dans une future mise à jour
Vous voulez vous assurer que votre fonctionnalité soit créée ?
Dans certains cas, les demandes de fonctionnalités peuvent ne pas convenir au cœur du logiciel (core). Vous pouvez lire comment les décisions concernant les fonctionnalités sont prises. Si vous ne pouvez pas développer la fonctionnalité vous-même, il existe toujours des moyens d’augmenter les chances qu’elle soit créée.
Devenez client de discourse.org
Si vous souhaitez financer le développement en hébergeant des sites avec nous – nous priorisons toujours les demandes des clients dans notre calendrier de développement – c’est un moyen d’obtenir une implémentation plus rapide. Les clients Enterprise peuvent demander des fonctionnalités personnalisées (généralement sous forme de plugin) à l’équipe principale, facturées au taux horaire.
Parrainer une tâche « pr-welcome »
Nous disposons d’une liste complète de sujets pr-welcome. Ce sont des tâches que nous aimerions voir réalisées, mais pour lesquelles nous n’avons actuellement pas la capacité de travailler nous-mêmes. Parrainer quelqu’un pour qu’il travaille sur ces tâches est un excellent moyen de s’impliquer, et toute contribution à Discourse est grandement appréciée.
Proposer un travail rémunéré sur le Marketplace
S’il y a un plugin dont vous avez besoin et qui est critique pour votre entreprise, annoncez une mission rémunérée sur la catégorie Marketplace. Fournissez autant de détails que possible, y compris des captures d’écran et un budget. Vous pourriez également trouver des freelances proposant des microservices standardisés tels que « installation unique » ou « thème personnalisé ».
Général
Bonnes et mauvaises pratiques générales
À faire
- Gardez votre demande concise et centrée sur une seule fonctionnalité
- Évitez de faire des hypothèses sur l’implémentation ou les détails techniques
- Montrez votre volonté de faire des compromis et d’adapter votre idée en fonction des retours de la communauté
À ne pas faire
- Inclure plus d’une fonctionnalité par sujet
- Laisser les autres questionner la portée de votre demande
FAQ
Q : Que faire si je n’ai pas le temps de créer une demande de fonctionnalité détaillée ?
R : Si vous n’êtes pas en mesure de créer une demande détaillée sur le moment, réfléchissez à ce que vous voulez dire et réessayez plus tard. Cela garantit que vous présentez votre meilleur argument, ce qui augmente les chances que d’autres soutiennent votre demande et qu’elle soit ajoutée.
Q : Où dois-je publier ma demande de fonctionnalité ?
R : Utilisez la catégorie appropriée : les demandes de fonctionnalités doivent être publiées dans la catégorie #feature::category.
Q : Que faire si je ne suis pas sûr de l’étiquette à utiliser pour ma demande ?
R : Bien que les étiquettes correspondent aux noms des plugins et des composants de thème pour faciliter l’utilisation, un membre de l’équipe ou un utilisateur régulier ajoutera une étiquette appropriée à votre sujet si elle est laissée vide.
Soyez respectueux et ouvert d’esprit dans votre demande. Évitez d’utiliser la demande de fonctionnalité pour exprimer votre frustration. Tout langage ou comportement inapproprié peut entraîner le retard ou l’ignorance de votre demande.
Ressources supplémentaires
- Catégories : Contribute > Feature, Marketplace, Customization > Plugin, Customization > Extras, Customization > Theme, Customization > Theme component
- Étiquettes : 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
