Feature request: documentation
Nessuno ha ancora preso questa issue.
Valutazione
- Difficoltà
- 5/5
- Tempo stimato
- Più di una settimana
- Idoneità per principianti
- 25/100
- Tipo di issue
- Documentazione
- Chiarezza
- Da chiarire
- Stato di attività
- Ferma
- Stack tecnologico
- ruby
- Ambito
- documentation
Direzione di ricerca
L'issue non indica file, test o punti di ingresso. Inizia esaminando il codice Ruby del gem e la sua integrazione con EventMachine per mappare ciò che deve essere spiegato, quindi definisci l'ambito della documentazione e una checklist di completamento. Il lavoro è completato quando i percorsi di codice rilevanti e le relazioni di utilizzo sono documentati abbastanza bene da ridurre lo sforzo di navigazione indicato.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Descrizione
This gem desperately lacks documentation of the code. Navigating the code trying to figure out where something is instantiated and used when using it with my own code that's using EventMachine takes a lot of effort. Documenting the code would make this much easier.
I'm creating this feature request to track this effort.
- Lingua principale
- Ruby
- Stelle
- 238
- Fork
- 49
- Metriche di merge delle PR
- Nessuna PR unita negli ultimi 30g
Preparare l'ambiente
Questo progetto non fornisce container di sviluppo, Dockerfile né guida per i contributori, quindi l'ambiente è a tuo carico: parti dal suo README e consulta la nostra guida al primo contributo per i passaggi generali.
Come iniziare
- Leggi tutta la issue e poi la guida ai contributi del progetto.
- Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
- Fai un fork del repository e lavora su un branch.
- Apri una pull request che faccia riferimento al numero della issue.
Altre issue di faye/websocket-driver-ruby
-
Difficoltà 3/5 1-2 giorni Idoneità per principianti 35/100
faye/websocket-driver-ruby#96 · 1 commento ·
-
Difficoltà 3/5 1-2 giorni Idoneità per principianti 25/100
faye/websocket-driver-ruby#89 · 1 commento ·
-
Difficoltà 3/5 1-2 giorni Idoneità per principianti 35/100
faye/websocket-driver-ruby#86 · 3 commenti ·
-
Difficoltà 4/5 3-5 giorni Idoneità per principianti 25/100
faye/websocket-driver-ruby#84 · 2 commenti ·
-
Difficoltà 4/5 3-5 giorni Idoneità per principianti 30/100
faye/websocket-driver-ruby#82 · 4 commenti · 1 reazione ·
Tutte le issue di faye/websocket-driver-ruby
Issue simili
-
Falha nos links do postAperta
Difficoltà 2/5 1-3 ore Idoneità per principianti 65/100
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 85/100
temporalio/sdk-ruby#625 ·
I maintainer di solito rispondono entro 1 giorno
-
Difficoltà 1/5 1-3 ore Idoneità per principianti 94/100
zerocracy/judges-action#2803 ·
I maintainer di solito rispondono entro 5 giorni
-
empty tone.rbAperta
Difficoltà 1/5 Meno di un'ora Idoneità per principianti 78/100
-
Difficoltà 1/5 1-3 ore Idoneità per principianti 92/100