Riepilogo
Questo argomento di documentazione copre la scrittura di una richiesta di funzionalità in Discourse: una guida passo passo.
Passaggio 1: Prima di iniziare
Quindi, hai un’ottima idea per una funzionalità di Discourse? Fantastico! Ecco come puoi condividerla in modo efficace con il team e la community. Prima di inviare una richiesta di funzionalità, prenditi un momento per cercare le discussioni esistenti per vedere se la tua idea è già stata suggerita o implementata. Puoi farlo in un paio di modi:
- Cercando nella categoria Feature
- Facendo clic sull’icona
nell’angolo in alto a destra della pagina per aprire la ricerca. Puoi utilizzare filtri avanzati per filtrare per categoria e tag. - Esaminando gli argomenti con i tag pr-welcome - Un PR è una pull request su GitHub - un modo per gli sviluppatori di introdurre nuovo codice in un progetto.
- Esaminando gli argomenti con il tag completed
- Cercando nella categoria Plugin
Se il tuo suggerimento di funzionalità è già elencato, puoi supportarlo votando per renderlo più evidente, mettendogli “mi piace” e rispondendo con idee aggiuntive o casi d’uso, per comunicare ulteriormente la sua utilità e perché la funzionalità dovrebbe essere aggiunta.
Non riesci a trovare alcuna menzione della tua idea? Puoi creare una richiesta di funzionalità.
Passaggio 2: Le basi
Titolo
È importante che i titoli degli argomenti siano informativi, ma allo stesso tempo non troppo lunghi. L’ambito della richiesta dovrebbe essere facilmente identificabile a colpo d’occhio.
Categoria
Quando crei un nuovo argomento, seleziona la categoria Feature.
Tag
I tag vengono utilizzati per raggruppare e classificare le funzionalità, quindi, per mantenere organizzate le richieste, taggare correttamente il tuo argomento è molto utile ai fini del tracciamento. Ad esempio, tutto ciò che riguarda il plugin chat viene tenuto insieme sotto un unico tag.
Passaggio 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 proporre la tua idea e convincere le persone che la tua idea per una funzionalità è ben fondata. Spiega perché vuoi che la tua funzionalità venga aggiunta: alla community, a te stesso e al Team.
Nel corpo del tuo argomento, indica concisamente la funzionalità che stai richiedendo. Sii specifico e descrittivo, evita di essere vago o aperto.
Fornire contesto e spiegazione
Fornisci contesto e spiegazione per la tua richiesta di funzionalità.
- Una chiara descrizione della funzionalità che stai richiedendo
- Includi il problema o i casi d’uso della tua attuale difficoltà e come la tua funzionalità lo risolverebbe
- Qualsiasi informazione di background pertinente o ricerca che hai fatto
Fornire esempi e screenshot (facoltativo)
Se applicabile, fornisci esempi, mockup o screenshot per aiutare a illustrare la tua richiesta di funzionalità in modo che altri possano visualizzare facilmente la tua idea.
Interagisci con la community
Una volta creata la tua richiesta di funzionalità, interagisci con i membri rispondendo a domande e feedback. Ciò aumenterà le possibilità che la tua richiesta venga presa in considerazione.
Cosa aspettarsi dopo
Dopo aver inviato la tua richiesta di funzionalità, verrà esaminata dalla community e dal Team di Discourse. Puoi aspettarti:
- Feedback e discussione dalla community
- Una risposta dallo staff di Discourse che indica se la tua richiesta è fattibile e in fase di valutazione
- Potenziale implementazione della tua richiesta di funzionalità in un futuro aggiornamento
Vuoi assicurarti che la tua funzionalità venga realizzata?
In alcuni casi, le richieste di funzionalità potrebbero non essere adatte al core. Puoi leggere come vengono prese le decisioni sulle funzionalità. Se non sei in grado di sviluppare la funzionalità da solo, ci sono ancora modi per aumentare le possibilità che venga realizzata.
Diventa un cliente discourse.org
Se desideri finanziare lo sviluppo ospitando siti con noi, diamo sempre la priorità alle richieste dei clienti nella nostra pianificazione di sviluppo: questo è un modo per realizzarla più velocemente. I clienti Enterprise possono richiedere funzionalità personalizzate (solitamente sotto forma di plugin) al team principale a una tariffa oraria.
Sponsorizza un’attività “pr-welcome”
Abbiamo un elenco completo di argomenti pr-welcome. Queste sono attività che ci piacerebbe vedere completate, ma attualmente non abbiamo la larghezza di banda per lavorarci noi stessi. Sponsorizzare qualcuno per lavorare su queste attività è un ottimo modo per essere coinvolti e ogni contributo a Discourse è molto apprezzato.
Offri lavoro retribuito sul Marketplace
Se c’è un plugin di cui hai bisogno ed è fondamentale per la tua attività, pubblicizza un incarico retribuito sul marketplace::category Marketplace. Fornisci quanti più dettagli possibile, inclusi screenshot e budget. Potresti anche trovare freelancer che offrono microservizi standardizzati come “installazione una tantum” o “tema personalizzato”.
Generale
Regole generali da seguire e da non seguire
Fare
- Mantieni la tua richiesta concisa e focalizzata su una singola funzionalità
- Evita di fare supposizioni sull’implementazione o sui dettagli tecnici
- Mostra la volontà di scendere a compromessi e adattare la tua idea in base al feedback della community
Non fare
- Includere più di una funzionalità per argomento
- Lasciare gli altri con dubbi sull’ambito della tua richiesta
FAQ
D: Cosa succede se non ho tempo per creare una richiesta di funzionalità dettagliata?
R: Se al momento non sei in grado di creare una richiesta dettagliata, rifletti su ciò che vuoi dire e riprova più tardi. Ciò garantisce che tu presenti il tuo caso migliore, aumentando la probabilità che altri supportino la tua richiesta e che venga aggiunta.
D: Dove dovrei pubblicare la mia richiesta di funzionalità?
R: Usa la categoria appropriata: le richieste di funzionalità dovrebbero andare nella categoria Feature.
D: Cosa succede 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 Regular aggiungerà un tag appropriato al tuo argomento se viene lasciato vuoto.
Sii rispettoso e aperto nella tua richiesta. Evita di usare la richiesta di funzionalità per esprimere frustrazione. Qualsiasi linguaggio o comportamento inappropriato può comportare il ritardo o l’ignoranza della tua richiesta.
Risorse aggiuntive
- 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
- Argomenti taggati planned
- Extras - Discourse Meta
