Zusammenfassung
Dieses Dokumentations-Thema behandelt das Verfassen einer Funktionsanfrage in Discourse: Eine Schritt-für-Schritt-Anleitung.
Schritt 1: Bevor Sie beginnen
Sie haben eine großartige Idee für eine Discourse-Funktion? Das ist fantastisch! Hier erfahren Sie, wie Sie diese effektiv mit dem Team und der Community teilen können. Bevor Sie eine Funktionsanfrage einreichen, nehmen Sie sich einen Moment Zeit, um bestehende Diskussionen zu durchsuchen, um festzustellen, ob Ihre Idee bereits vorgeschlagen oder umgesetzt wurde. Dies können Sie auf verschiedene Arten tun:
- Suche in der Kategorie Feature
- Klicken Sie auf das
Symbol in der oberen rechten Ecke der Seite, um die Suche aufzurufen. Sie können erweiterte Filter verwenden, um nach Kategorie und Tag zu filtern. - Durchsuchen Sie Themen mit dem Tag pr-welcome - Ein PR ist ein Pull Request auf GitHub – eine Möglichkeit für Entwickler, neuen Code in ein Projekt einzubringen.
- Durchsuchen Sie Themen mit dem Tag completed
- Suchen Sie in den Kategorien Plugin und Theme component
Wenn Ihr Funktionsvorschlag bereits aufgeführt ist, können Sie ihn unterstützen, indem Sie dafür abstimmen, um seine Sichtbarkeit zu erhöhen, ihn liken und mit zusätzlichen Ideen oder Anwendungsfällen antworten, um seinen Nutzen und den Grund für seine Aufnahme weiter zu kommunizieren.
Können Sie keinen Hinweis auf Ihre Idee finden? Dann können Sie eine Funktionsanfrage erstellen.
Schritt 2: Die Grundlagen
Titel
Es ist wichtig, dass Thementitel informativ, aber gleichzeitig nicht zu lang sind. Der Umfang der Anfrage sollte auf einen Blick erkennbar sein.
Kategorie
Wählen Sie beim Erstellen eines neuen Themas die Kategorie Feature.
Tag
Tags werden verwendet, um Funktionen zu gruppieren und zu klassifizieren. Um Anfragen organisiert zu halten, ist es sehr hilfreich, Ihr Thema entsprechend zu taggen, um die Nachverfolgung zu erleichtern. Beispielsweise wird alles, was sich auf das Plugin chat bezieht, unter einem Tag zusammengefasst.
Schritt 3: Schreiben Ihrer Anfrage
Das Verfassen einer guten Funktionsanfrage ist wichtig, da es dem Discourse-Team hilft, Bereiche, die möglicherweise verbessert werden müssen, schnell zu erkennen.
Denken Sie daran, dass Sie bei der Erstellung einer Funktionsanfrage versuchen, Ihre Idee vorzustellen und andere davon zu überzeugen, dass Ihre Funktionsidee gut begründet ist. Erklären Sie, warum Sie Ihre Funktion hinzufügen möchten: für die Community, für sich selbst und für das Team.
Geben Sie im Hauptteil Ihres Themas die angeforderte Funktion prägnant an. Seien Sie spezifisch und beschreibend, vermeiden Sie vage oder offene Formulierungen.
Kontext und Erklärung bereitstellen
Stellen Sie Kontext und Erklärungen für Ihre Funktionsanfrage bereit.
- Eine klare Beschreibung der angeforderten Funktion
- Beschreiben Sie das Problem oder die Anwendungsfälle Ihrer aktuellen Schwierigkeiten und wie Ihre Funktion diese lösen würde
- Alle relevanten Hintergrundinformationen oder Recherchen, die Sie durchgeführt haben
Beispiele und Screenshots bereitstellen (Optional)
Fügen Sie, falls zutreffend, Beispiele, Mock-ups oder Screenshots bei, um Ihre Funktionsanfrage zu veranschaulichen, damit andere Ihre Idee leicht visualisieren können.
Mit der Community interagieren
Sobald Sie Ihre Funktionsanfrage 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 Funktionsanfrage eingereicht haben, wird sie von der Community und dem Discourse-Team geprüft. Sie können Folgendes erwarten:
- Feedback und Diskussionen aus der Community
- Eine Antwort vom Discourse-Personal, die angibt, ob Ihre Anfrage machbar und in Prüfung ist
- Mögliche Implementierung Ihrer Funktionsanfrage in einem zukünftigen Update
Möchten Sie sicherstellen, dass Ihre Funktion umgesetzt wird?
In einigen Fällen sind Funktionsanfragen möglicherweise nicht für den Kern geeignet. Sie können lesen, wie Entscheidungen über Funktionen getroffen werden. Wenn Sie die Funktion nicht selbst entwickeln können, gibt es dennoch Möglichkeiten, die Chancen auf ihre Umsetzung zu erhöhen.
Werden Sie ein discourse.org-Kunde
Wenn Sie die Entwicklung durch das Hosten von Websites bei uns finanzieren möchten – wir priorisieren Kundenanfragen immer in unserem Entwicklungsplan – ist dies ein Weg, sie schneller umzusetzen. Enterprise-Kunden können benutzerdefinierte Funktionen (normalerweise in Form eines Plugins) vom Kernteam zu einem Stundensatz anfordern.
Sponsern Sie eine „pr-welcome“-Aufgabe
Wir haben eine umfassende Liste von pr-welcome-Themen. Dies sind Aufgaben, die wir gerne erledigt sehen würden, für die wir aber derzeit nicht die Kapazität haben, sie selbst zu bearbeiten. Das Sponsern 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 in der Kategorie Marketplace aus. Geben Sie so viele Details wie möglich an, einschließlich Screenshots und Budget. Möglicherweise finden Sie auch Freelancer, die standardisierte Mikrodienste wie „Einmalige Installation“ oder „Personalisiertes Thema“ anbieten.
Allgemein
Allgemeine Do’s und Don’ts
Do’s
- Halten Sie Ihre Anfrage prägnant und auf eine einzelne Funktion konzentriert
- Vermeiden Sie Annahmen über Implementierung oder technische Details
- Zeigen Sie die Bereitschaft, Ihre Idee basierend auf Community-Feedback zu kompromittieren und anzupassen
Don’ts
- Fügen Sie mehr als eine Funktion pro Thema hinzu
- Lassen Sie andere über den Umfang Ihrer Anfrage im Unklaren
FAQs
F: Was ist, wenn ich keine Zeit habe, eine detaillierte Funktionsanfrage 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 präsentieren, was die Wahrscheinlichkeit erhöht, dass andere Ihre Anfrage unterstützen und sie aufgenommen wird.
F: Wo soll ich meine Funktionsanfrage posten?
A: Verwenden Sie die entsprechende Kategorie – Funktionsanfragen gehören in die Kategorie Feature.
F: Was ist, wenn ich mir nicht sicher bin, welchen Tag ich für meine Anfrage verwenden soll?
A: Obwohl Tags zur einfacheren Verwendung mit Plugin- und Theme-Component-Namen übereinstimmen, wird ein Mitglied des Teams oder ein Regular einen geeigneten Tag zu Ihrem Thema hinzufügen, wenn es leer gelassen wird.
Seien Sie in Ihrer Anfrage respektvoll und aufgeschlossen. Vermeiden Sie es, die Funktionsanfrage zu nutzen, um Frustration auszudrücken. Unangemessene Sprache oder Verhalten können dazu führen, dass Ihre Anfrage verzögert oder ignoriert wird.
Zusätzliche Ressourcen
- Kategorien: Feature, Marketplace, Plugin, Plugin > Extras, Theme, 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
