Résumé
Ce sujet de documentation couvre la rédaction d’une demande de fonctionnalité dans Discourse : Un guide étape par étape.
Étape 1 : Avant de commencer
Vous avez une excellente idée pour une fonctionnalité Discourse ? C’est fantastique ! Voici comment vous pouvez 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 mise en œuvre. Vous pouvez le faire de plusieurs manières :
- En consultant la catégorie Feature
- En cliquant sur l’icône
dans le coin supérieur droit de la page pour ouvrir la recherche. Vous pouvez utiliser des filtres avancés pour filtrer par catégorie et par étiquette. - En consultant les sujets avec l’étiquette pr-welcome - Une PR est une pull request sur GitHub - une manière pour les développeurs d’introduire du nouveau code dans un projet.
- En consultant les sujets avec l’étiquette completed
- En consultant les catégories Plugin et Theme component
Si votre suggestion de fonctionnalité est déjà listée, vous pouvez la soutenir en votant pour elle afin de rendre ses demandes plus visibles, en l’aimant, et en répondant avec des idées ou des cas d’utilisation supplémentaires, pour mieux communiquer son utilité et expliquer 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 en même temps pas trop longs. La portée de la demande doit être facilement identifiable en un coup d’œil.
Catégorie
Lors de la création d’un nouveau sujet, veuillez sélectionner la catégorie Feature.
Étiquette
Les étiquettes sont utilisées pour regrouper et classer les fonctionnalités. Par conséquent, afin de garder les demandes organisées, étiqueter votre sujet de manière appropriée est très utile à des fins de suivi. Par exemple, tout ce qui est lié au 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 Discourse à identifier rapidement les domaines qui pourraient nécessiter des améliorations.
Rappelez-vous, lorsque vous créez une demande de fonctionnalité, vous essayez de présenter votre idée et de convaincre les gens que votre idée de fonctionnalité est bien fondée. Expliquez pourquoi vous souhaitez que votre fonctionnalité soit ajoutée : à la communauté, à vous-même et à l’Équipe.
Dans le corps de votre sujet, énoncez de manière concise la fonctionnalité que vous demandez. Soyez précis et descriptif, évitez d’être vague ou ouvert.
Fournir le contexte et l’explication
Fournissez le contexte et l’explication pour votre demande de fonctionnalité.
- Une description claire de la fonctionnalité que vous demandez
- Incluez le problème ou les cas d’utilisation de votre difficulté actuelle et comment votre fonctionnalité pourrait le résoudre
- Toute information de fond ou recherche pertinente que vous avez effectuée
Fournir des exemples et des captures d’écran (Facultatif)
Si applicable, 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.
Interagir avec la communauté
Une fois que vous avez créé votre demande de fonctionnalité, interagissez avec les membres en répondant aux questions et aux commentaires. Cela augmentera les chances que votre demande soit examinée.
À quoi s’attendre ensuite
Après avoir soumis votre demande de fonctionnalité, elle sera examinée par la communauté et l’équipe Discourse. Vous pouvez vous attendre à :
- Des commentaires et des discussions de la part de la communauté
- Une réponse du personnel de Discourse indiquant si votre demande est réalisable et prise en considération
- Une mise en œuvre potentielle de votre demande de fonctionnalité dans une future mise à jour
Vous voulez vous assurer que votre fonctionnalité soit réalisée ?
Dans certains cas, les demandes de fonctionnalités peuvent ne pas être adaptées au cœur du système. Vous pouvez lire comment les décisions relatives aux fonctionnalités sont prises. Si vous n’êtes pas en mesure de développer la fonctionnalité vous-même, il existe toujours des moyens d’augmenter les chances qu’elle soit réalisée.
Devenir un client 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 de la faire intégrer plus rapidement. Les clients Entreprise peuvent demander des fonctionnalités personnalisées (généralement sous la forme d’un plugin) par l’équipe principale à un tarif horaire.
Parrainer une tâche « pr-welcome »
Nous avons une liste complète de sujets pr-welcome. Ce sont des tâches que nous aimerions voir accomplies, mais pour lesquelles nous n’avons actuellement pas la bande passante pour travailler nous-mêmes. Parrainer quelqu’un pour travailler 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 la Place de marché
S’il y a un plugin dont vous avez besoin qui est essentiel à 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 le budget. Vous pourriez également trouver des freelances proposant des microservices standardisés comme « installation unique » ou « thème personnalisé ».
Généralités
À faire et à ne pas faire généraux
À faire
- Gardez votre demande concise et concentrée sur une seule fonctionnalité
- Évitez de faire des suppositions sur la mise en œuvre ou les détails techniques
- Faites preuve de volonté de compromis et d’adaptation de votre idée en fonction des commentaires de la communauté
À ne pas faire
- Inclure plus d’une fonctionnalité par sujet
- Laisser les autres s’interroger sur 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 aller dans la catégorie Feature.
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 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 : Feature, Marketplace, Plugin, Plugin > Extras, Theme, 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
