Zusammenfassung
Dieses Dokument behandelt das Erstellen einer Feature-Anfrage in Discourse: Ein Schritt-für-Schritt-Leitfaden.
Schritt 1: Vor dem Start
Du hast eine großartige Idee für ein Discourse-Feature? Das ist fantastisch! Hier erfährst du, wie du sie effektiv mit dem Team und der Community teilen kannst. Bevor du eine Feature-Anfrage einreichst, nimm dir bitte einen Moment Zeit, um nach bestehenden Diskussionen zu suchen, um festzustellen, ob deine Idee bereits vorgeschlagen oder implementiert wurde. Dies kannst du auf verschiedene Arten tun:
- Suche in der Kategorie Contribute > Feature
- Klicke auf das
Symbol in der oberen rechten Ecke der Seite, um die Suche aufzurufen. Du kannst erweiterte Filter verwenden, um nach Kategorie und Tag zu filtern. - Durchsuche 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.
- Durchsuche Themen mit dem Tag completed
- Suche in den Kategorien Customization > Plugin und Customization > Theme component
Falls dein Feature-Vorschlag bereits aufgeführt ist, kannst du ihn unterstützen, indem du dafür abstimst, um die Anfrage sichtbarer zu machen, ihn mit einem Like versiehst und mit zusätzlichen Ideen oder Anwendungsfällen antwortest, um die Nützlichkeit des Features und die Gründe für seine Einführung weiter zu verdeutlichen.
Konntest du keine Erwähnung deiner Idee finden? Dann kannst du eine Feature-Anfrage erstellen.
Schritt 2: Die Grundlagen
Titel
Es ist wichtig, dass Titel von Themen informativ sind, aber gleichzeitig nicht zu lang. Der Umfang der Anfrage sollte auf den ersten Blick erkennbar sein.
Kategorie
Bitte wähle beim Erstellen eines neuen Themas die Kategorie Contribute > Feature aus.
Tag
Tags werden verwendet, um Features zu gruppieren und zu klassifizieren. Um die Anfragen organisiert zu halten, ist es daher sehr hilfreich, dein Thema entsprechend zu taggen, um es besser verfolgen zu können. Beispielsweise werden alle Dinge, die mit dem Plugin chat zu tun haben, unter einem Tag zusammengefasst.
Schritt 3: Schreiben deiner Anfrage
Das Schreiben einer guten Feature-Anfrage ist wichtig, da sie dem Discourse-Team hilft, Bereiche, die verbessert werden könnten, schnell zu identifizieren.
Denke daran: Wenn du eine Feature-Anfrage erstellst, versuchst du, deine Idee zu präsentieren und die Leute davon zu überzeugen, dass dein Feature-Vorschlag gut begründet ist. Erkläre, warum du möchtest, dass dein Feature hinzugefügt wird – für die Community, für dich selbst und für das Team.
Formuliere im Hauptteil deines Themas das gewünschte Feature präzise. Sei spezifisch und beschreibend, vermeide vage oder offene Formulierungen.
Kontext und Erklärung bereitstellen
Stelle Kontext und Erklärungen für deine Feature-Anfrage bereit.
- Eine klare Beschreibung des gewünschten Features
- Nenne das Problem oder die Anwendungsfälle, mit denen du aktuell zu kämpfen hast, und erkläre, wie dein Feature dies lösen würde
- Alle relevanten Hintergrundinformationen oder Recherchen, die du durchgeführt hast
Beispiele und Screenshots bereitstellen (Optional)
Falls zutreffend, stelle Beispiele, Mock-ups oder Screenshots bereit, um deine Feature-Anfrage zu veranschaulichen, damit andere deine Idee leicht visualisieren können.
Mit der Community interagieren
Sobald du deine Feature-Anfrage erstellt hast, interagiere mit den Mitgliedern, indem du auf Fragen und Feedback antwortest. Dies erhöht die Chancen, dass deine Anfrage berücksichtigt wird.
Was als Nächstes zu erwarten ist
Nachdem du deine Feature-Anfrage eingereicht hast, wird sie von der Community und dem Discourse-Team überprüft. Du kannst Folgendes erwarten:
- Feedback und Diskussionen aus der Community
- Eine Antwort von Discourse-Mitarbeitern, die angibt, ob deine Anfrage machbar ist und geprüft wird
- Mögliche Implementierung deiner Feature-Anfrage in einem zukünftigen Update
Möchtest du sicherstellen, dass dein Feature umgesetzt wird?
In einigen Fällen sind Feature-Anfragen möglicherweise nicht für den Core geeignet. Du kannst hier nachlesen, wie Entscheidungen über Features getroffen werden. Wenn du das Feature nicht selbst entwickeln kannst, gibt es dennoch Möglichkeiten, die Chancen auf eine Umsetzung zu erhöhen.
Kunde von discourse.org werden
Wenn du die Entwicklung durch das Hosting von Seiten bei uns finanzieren möchtest – wir priorisieren Kundenanfragen in unserem Entwicklungsplan immer – ist dies eine Möglichkeit, dies schneller umzusetzen. Enterprise-Kunden können vom Core-Team individuelle Features (meist in Form von Plugins) gegen eine Stundenabrechnung anfordern.
Eine „pr-welcome“-Aufgabe sponsern
Wir haben eine umfassende Liste von pr-welcome-Themen. Dies sind Aufgaben, die wir gerne abgeschlossen sehen, für die wir jedoch derzeit nicht genug Kapazitäten haben. Das Sponsoring einer Person für die Bearbeitung dieser Aufgaben ist eine großartige Möglichkeit, sich zu engagieren. Jeder Beitrag zu Discourse wird sehr geschätzt.
Bezahlte Arbeit auf dem Marketplace anbieten
Falls es ein Plugin gibt, das für dein Unternehmen kritisch ist, kannst du eine bezahlte Aufgabe im Marketplace ausschreiben. Gib so viele Details wie möglich an, einschließlich Screenshots und Budgets. Möglicherweise findest du auch Freelancer, die standardisierte Microservices wie „Einmalige Installation“ oder „Personalisiertes Theme“ anbieten.
Übersicht
Allgemeine Tipps und Empfehlungen
Tun
- Halte deine Anfrage knapp und konzentriere dich auf ein einzelnes Feature
- Mache keine Annahmen über die Implementierung oder technische Details
- Zeige Bereitschaft zur Kompromissfindung und passe deine Idee basierend auf dem Community-Feedback an
Lass es
- Füge nicht mehr als ein Feature pro Thema hinzu
- Hinterlasse keine Unsicherheit bezüglich des Umfangs deiner Anfrage
Häufig gestellte Fragen (FAQs)
F: Was, wenn ich keine Zeit habe, eine detaillierte Feature-Anfrage zu erstellen?
A: Wenn du im Moment keine detaillierte Anfrage erstellen kannst, überlege dir, was du sagen möchtest, und versuche es später erneut. So stellst du sicher, dass du dein Anliegen bestmöglich vorbringst, was die Wahrscheinlichkeit erhöht, dass andere deine Anfrage unterstützen und sie umgesetzt wird.
F: Wo sollte ich meine Feature-Anfrage veröffentlichen?
A: Verwende die passende Kategorie – Feature-Anfragen sollten in der Kategorie #feature::category veröffentlicht werden.
F: Was, wenn ich unsicher bin, welches Tag ich für meine Anfrage verwenden soll?
A: Obwohl Tags zur Vereinfachung den Namen von Plugins und Theme-Komponenten entsprechen, wird ein Mitglied des Teams oder ein „Regular“ (erfahrenes Community-Mitglied) ein passendes Tag an dein Thema anhängen, falls es leer gelassen wird.
Sei respektvoll und aufgeschlossen in deiner Anfrage. Vermeide es, Feature-Anfragen dazu zu nutzen, Frustration auszudrücken. Jede unangemessene Sprache oder jedes unangemessene Verhalten kann dazu führen, dass deine Anfrage verzögert oder ignoriert wird.
Zusätzliche Ressourcen
- Kategorien: Contribute > Feature, Marketplace, Customization > Plugin, Customization > Extras, Customization > Theme, Customization > Theme component
- Tags: 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
