Scrivere una richiesta di funzionalità efficace: una guida passo dopo passo

Riepilogo

Questa documentazione tratta la creazione di una richiesta di funzionalità su Discourse: una guida passo dopo passo.

Passo 1: Prima di iniziare

Hai un’ottima idea per una funzionalità di Discourse? Fantastico! Ecco come puoi condividerla efficacemente con il team e la comunità. Prima di inviare una richiesta di funzionalità, dedica un momento a cercare nelle discussioni esistenti per verificare se la tua idea è già stata suggerita o implementata. Puoi farlo in diversi modi:

  • Cercando nella categoria Contribute > Feature
  • Cliccando sull’icona :mag: nell’angolo in alto a destra della pagina per aprire la ricerca. Puoi utilizzare filtri avanzati per filtrare per categoria e tag.
  • Esaminando i topic con i tag pr-welcome - Una PR (Pull Request) è una richiesta di pull su GitHub, un modo per gli sviluppatori di introdurre nuovo codice in un progetto.
  • Esaminando i topic con il tag completed
  • Cercando nelle categorie Customization > Plugin e Customization > Theme component

Se la tua idea è già elencata, puoi sostenerla votandola per renderla più visibile, mettendoci un “mi piace” e rispondendo con idee o casi d’uso aggiuntivi, per comunicare ulteriormente la sua utilità e il motivo per cui dovrebbe essere aggiunta.

Non trovi alcun riferimento alla tua idea? Puoi creare una richiesta di funzionalità.


Passo 2: Le basi

Titolo
È importante che i titoli dei topic siano informativi, ma allo stesso tempo non troppo lunghi. L’ambito della richiesta dovrebbe essere identificabile a colpo d’occhio.

Categoria
Quando crei un nuovo topic, seleziona la categoria Contribute > Feature.

Tag
I tag vengono utilizzati per raggruppare e classificare le funzionalità; pertanto, per mantenere ordinate le richieste, taggare il proprio topic in modo appropriato è molto utile per il tracciamento. Ad esempio, tutto ciò che riguarda il plugin chat viene mantenuto insieme sotto un unico tag.


Passo 3: Scrivere la tua richiesta

Scrivere una buona richiesta di funzionalità è importante, aiuta il team di Discourse a identificare rapidamente le aree che potrebbero necessitare di miglioramenti.

Ricorda, quando crei una richiesta di funzionalità, stai cercando di presentare la tua idea e convincere le persone che la tua idea per una funzionalità è ben fondata. Spiega perché desideri che la tua funzionalità venga aggiunta: per la comunità, per te stesso e per il Team.

Nel corpo del tuo topic, dichiara in modo conciso la funzionalità che stai richiedendo. Sii specifico e descrittivo, evita di essere vago o aperto a interpretazioni.

Fornisci contesto e spiegazione

Fornisci contesto e spiegazione per la tua richiesta di funzionalità.

  • Una descrizione chiara della funzionalità che stai richiedendo
  • Includi il problema o i casi d’uso della tua attuale difficoltà e come la tua funzionalità potrebbe risolverlo
  • Qualsiasi informazione di background o ricerca pertinente che hai effettuato

Fornisci esempi e screenshot (Opzionale)

Se applicabile, fornisci esempi, mock-up o screenshot per aiutare a illustrare la tua richiesta di funzionalità, in modo che altri possano visualizzare facilmente la tua idea.

Coinvolgi la comunità

Una volta creata la tua richiesta di funzionalità, interagisci con i membri rispondendo alle domande e ai feedback. Questo aumenterà le possibilità che la tua richiesta venga presa in considerazione.

Cosa aspettarsi

Dopo aver inviato la tua richiesta di funzionalità, verrà esaminata dalla comunità e dal team di Discourse. Puoi aspettarti:

  • Feedback e discussioni dalla comunità
  • Una risposta dal personale di Discourse che indica se la tua richiesta è fattibile e in fase di considerazione
  • Possibile implementazione della tua richiesta di funzionalità in un aggiornamento futuro

Vuoi assicurarti che la tua funzionalità venga realizzata?

In alcuni casi, le richieste di funzionalità potrebbero non essere adatte per il nucleo principale (core). Puoi leggere come vengono prese le decisioni sulle funzionalità. Se non sei in grado di sviluppare la funzionalità tu stesso, ci sono comunque modi per aumentare le possibilità che venga realizzata.

Diventa un cliente di discourse.org

Se desideri finanziare lo sviluppo ospitando i siti con noi, diamo sempre priorità alle richieste dei clienti nella nostra pianificazione dello sviluppo; questo è un modo per farla implementare più rapidamente. I client Enterprise possono richiedere funzionalità personalizzate (solitamente sotto forma di plugin) dal team principale a un tariffa oraria.

Sponsorizza un compito “pr-welcome”

Abbiamo un elenco completo di topic pr-welcome. Questi sono compiti che ci piacerebbe vedere completati, ma attualmente non abbiamo le risorse per lavorarci noi stessi. Sponsorizzare qualcuno per lavorare su questi compiti è un ottimo modo per coinvolgersi e qualsiasi contributo a Discourse è molto apprezzato.

Offri lavoro retribuito sul Marketplace

Se c’è un plugin di cui hai bisogno che è critico per la tua attività, pubblica un incarico retribuito nella categoria Marketplace. Fornisci il maggior numero di dettagli possibile, inclusi screenshot e budget. Potresti anche trovare freelancer che offrono microservizi standardizzati come “installazione una tantum” o “tema personalizzato”.


In generale

Linee guida generali

Da fare

  • Mantieni la tua richiesta concisa e focalizzata su una singola funzionalità
  • Evita di fare assunzioni sull’implementazione o sui dettagli tecnici
  • Mostra disponibilità a comprometterti e adattare la tua idea in base al feedback della comunità

Da non fare

  • Includere più di una funzionalità per topic
  • Lasciare gli altri a interrogarsi sull’ambito della tua richiesta

Domande frequenti (FAQ)

D: E se non ho tempo per creare una richiesta di funzionalità dettagliata?
R: Se in quel momento non sei in grado di creare una richiesta dettagliata, rifletti su ciò che vuoi dire e riprova più tardi. Questo garantisce di presentare il tuo caso migliore, aumentando le possibilità che gli altri supportino la tua richiesta e che essa venga aggiunta.

D: Dove dovrei pubblicare la mia richiesta di funzionalità?
R: Utilizza la categoria appropriata: le richieste di funzionalità dovrebbero andare nella categoria #feature::category.

D: E se non sono sicuro di quale tag usare per la mia richiesta?
R: Sebbene i tag corrispondano ai nomi dei plugin e dei componenti del tema per facilità d’uso, un membro del Team o un Utente Abituale aggiornerà il topic aggiungendo un tag appropriato se viene lasciato vuoto.

Sii rispettoso e aperto nelle tue richieste. Evita di usare la richiesta di funzionalità per esprimere frustrazione. Qualsiasi linguaggio o comportamento inappropriato può comportare il ritardo o l’ignoramento della tua richiesta.

Risorse aggiuntive

17 Mi Piace

Ciò significa che posso aspettarmi risposte dallo staff sulle mie richieste di funzionalità in sospeso? :innocent: :sweat_smile: :smiley:

2 Mi Piace

L’ho scritto perché quando ho dato una rapida occhiata alle funzionalità, la maggior parte degli argomenti ha una risposta da un membro del team. Mi piacciono le tue richieste di funzionalità :smile:

3 Mi Piace

Penso che questa sia una delle cose più importanti, e spesso non riceve abbastanza enfasi:

È davvero utile avere la massima comprensione di questo, nei termini più concreti possibile.

Quando altri intervengono sulle richieste di funzionalità altrui, questa è anche la parte che di solito cerco, poiché persone diverse hanno spesso problemi leggermente diversi.

Inoltre, sapere come le persone risolvono attualmente quel problema è anche molto utile (ad esempio, qual è la tua attuale soluzione alternativa o soluzione al problema).

6 Mi Piace