Zusammenfassung
Dieses Dokumentations-Thema behandelt das Verfassen einer Feature-Anfrage in Discourse: Eine Schritt-für-Schritt-Anleitung.
Schritt 1: Bevor Sie beginnen
Sie haben also eine großartige Idee für ein Discourse-Feature? Das ist fantastisch! Hier erfahren Sie, wie Sie sie effektiv mit dem Team und der Community teilen können. Bevor Sie eine Feature-Anfrage einreichen, nehmen Sie sich bitte einen Moment Zeit, um bestehende Diskussionen zu durchsuchen, um zu sehen, ob Ihre Idee bereits vorgeschlagen oder implementiert wurde. Sie können dies auf verschiedene Arten tun:
- Suchen in der Kategorie Feature
- Indem Sie auf das
Symbol in der oberen rechten Ecke der Seite klicken, um die Suche aufzurufen. Sie können erweiterte Filter verwenden, um nach Kategorie und Tag zu filtern. - Durchsuchen von Themen mit den Tags pr-welcome - Ein PR ist ein Pull-Request auf GitHub - eine Möglichkeit für Entwickler, neuen Code in ein Projekt einzubringen.
- Durchsuchen von Themen mit dem Tag completed
- Suchen in der Kategorie Plugin
Wenn Ihr Feature-Vorschlag bereits aufgeführt ist, können Sie ihn unterstützen, indem Sie dafür abstimmen, um seine Anfragen prominenter zu machen, ihn liken und mit zusätzlichen Ideen oder Anwendungsfällen antworten, um seinen Nutzen weiter zu kommunizieren und zu erklären, warum das Feature hinzugefügt werden sollte.
Können Sie keine Erwähnung Ihrer Idee finden? Sie können eine Feature-Anfrage erstellen.
Schritt 2: Die Grundlagen
Titel
Es ist wichtig, dass die Titel von Themen informativ, aber gleichzeitig nicht zu lang sind. Der Umfang der Anfrage sollte auf einen Blick erkennbar sein.
Kategorie
Wählen Sie bei der Erstellung eines neuen Themas die Kategorie Feature.
Tag
Tags werden verwendet, um Features zu gruppieren und zu klassifizieren. Um Anfragen organisiert zu halten, ist das entsprechende Taggen Ihres Themas für die Nachverfolgung sehr hilfreich. Zum Beispiel werden alle Themen, die sich auf das chat Plugin beziehen, unter einem Tag zusammengefasst.
Schritt 3: Schreiben Sie Ihre Anfrage
Das Verfassen einer guten Feature-Anfrage ist wichtig, da es dem Discourse-Team hilft, schnell Bereiche zu identifizieren, die verbessert werden könnten.
Denken Sie daran, dass Sie bei der Erstellung einer Feature-Anfrage versuchen, Ihre Idee zu präsentieren und die Leute davon zu überzeugen, dass Ihre Idee für ein Feature gut begründet ist. Erklären Sie, warum Sie möchten, dass Ihr Feature hinzugefügt wird: für die Community, für sich selbst und für das Team.
Geben Sie im Hauptteil Ihres Themas prägnant das Feature an, das Sie anfordern. Seien Sie spezifisch und beschreibend, vermeiden Sie vage oder offene Aussagen.
Kontext und Erklärung bereitstellen
Stellen Sie Kontext und Erklärung für Ihre Feature-Anfrage bereit.
- Eine klare Beschreibung des Features, das Sie anfordern
- Beschreiben Sie das Problem oder die Anwendungsfälle Ihres aktuellen Problems und wie Ihr Feature es lösen würde
- Alle relevanten Hintergrundinformationen oder Recherchen, die Sie durchgeführt haben
Beispiele und Screenshots bereitstellen (Optional)
Stellen Sie, falls zutreffend, Beispiele, Mock-ups oder Screenshots bereit, um Ihre Feature-Anfrage zu veranschaulichen, damit andere Ihre Idee leicht visualisieren können.
Mit der Community interagieren
Sobald Sie Ihre Feature-Anfrage erstellt haben, interagieren Sie mit den Mitgliedern, indem Sie auf Fragen und Feedback antworten. Dies erhöht die Chancen, dass Ihre Anfrage berücksichtigt wird.
Was als Nächstes zu erwarten ist
Nachdem Sie Ihre Feature-Anfrage eingereicht haben, wird sie von der Community und dem Discourse-Team geprüft. Sie können Folgendes erwarten:
- Feedback und Diskussion von der Community
- Eine Antwort von Discourse-Mitarbeitern, die angibt, ob Ihre Anfrage machbar ist und in Betracht gezogen wird
- Mögliche Implementierung Ihrer Feature-Anfrage in einem zukünftigen Update
Möchten Sie sicherstellen, dass Ihr Feature umgesetzt wird?
In einigen Fällen sind Feature-Anfragen möglicherweise nicht für den Kern geeignet. Sie können lesen, wie Feature-Entscheidungen getroffen werden. Wenn Sie das Feature nicht selbst entwickeln können, gibt es immer noch Möglichkeiten, die Chancen auf seine Umsetzung zu erhöhen.
Werden Sie ein discourse.org Kunde
Wenn Sie die Entwicklung durch Hosting von Websites bei uns finanzieren möchten – wir priorisieren Kundenanfragen immer in unserem Entwicklungszeitplan –, ist dies eine Möglichkeit, sie schneller zu erhalten. Enterprise-Kunden können benutzerdefinierte Features (normalerweise in Form eines Plugins) vom Kernteam zu einem Stundensatz anfordern.
Sponsoring einer “pr-welcome”-Aufgabe
Wir haben eine umfassende Liste von pr-welcome Themen. Dies sind Aufgaben, die wir gerne erledigt sehen würden, aber derzeit nicht die Bandbreite haben, um sie selbst zu bearbeiten. Das Sponsoring einer Person, die an diesen Aufgaben arbeitet, ist eine großartige Möglichkeit, sich zu engagieren, und jeder Beitrag zu Discourse wird sehr geschätzt.
Bieten Sie bezahlte Arbeit auf dem Marktplatz an
Wenn Sie ein Plugin benötigen, das für Ihr Unternehmen von entscheidender Bedeutung ist, schalten Sie eine bezahlte Aufgabe im Marketplace. Geben Sie so viele Details wie möglich an, einschließlich Screenshots und Budget. Möglicherweise finden Sie auch Freiberufler, die standardisierte Microservices wie “einmalige Installation” oder “personalisiertes Thema” anbieten.
Insgesamt
Allgemeine Do’s und Don’ts
Tun Sie
- Halten Sie Ihre Anfrage prägnant und konzentrieren Sie sich auf ein einzelnes Feature
- Vermeiden Sie Annahmen über Implementierungs- oder technische Details
- Zeigen Sie Kompromissbereitschaft und passen Sie Ihre Idee basierend auf dem Feedback der Community an
Nicht tun
- Mehr als ein Feature pro Thema aufnehmen
- Andere über den Umfang Ihrer Anfrage im Unklaren lassen
FAQs
F: Was ist, wenn ich keine Zeit habe, eine detaillierte Feature-Anfrage zu erstellen?
A: Wenn Sie im Moment keine detaillierte Anfrage erstellen können, überlegen Sie, was Sie sagen möchten, und versuchen Sie es später erneut. Dies stellt sicher, dass Sie Ihren besten Fall darlegen, was die Wahrscheinlichkeit erhöht, dass andere Ihre Anfrage unterstützen und sie hinzugefügt wird.
F: Wo soll ich meine Feature-Anfrage posten?
A: Verwenden Sie die entsprechende Kategorie – Feature-Anfragen sollten in der Kategorie Feature gestellt werden.
F: Was ist, wenn ich mir nicht sicher bin, welches Tag ich für meine Anfrage verwenden soll?
A: Obwohl Tags Plugin- und Theme-Komponenten-Namen zur einfacheren Verwendung entsprechen, wird ein Mitglied des Teams oder ein Regular Ihrem Thema ein entsprechendes Tag hinzufügen, wenn es leer bleibt.
Seien Sie respektvoll und aufgeschlossen in Ihrer Anfrage. Vermeiden Sie es, die Feature-Anfrage zu nutzen, um Frustration auszudrücken. Unangemessene Sprache oder Verhalten kann dazu führen, dass Ihre Anfrage verzögert oder ignoriert wird.
Zusätzliche Ressourcen
- 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
- Topics tagged planned
- Extras - Discourse Meta
