lyft / lyft/coloralgorithm

Could you add some documentation?

Aperta
#7 2 commenti 3 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Lingua principale
JavaScript
Stelle
235
Fork
45
Metriche di merge delle PR
Nessuna PR unita negli ultimi 30g

Descrizione

Hi there!

Thanks for your work, the demo looks great!

I was wondering if you could add some basic documentation to the code and some words in your readme.

I would be interested in using this to generate color schemas for charts in [Britecharts](http://eventbrite.github.io/britecharts/). It could make for a nice demo to apply your algorithm to a chart.

Thanks again!

Guida per i contributori

Nessuna guida per i contributori indicizzata per questo repository

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Direzione di ricerca

Inizia esaminando il codice JavaScript e il README del repository per identificare cosa fa l’algoritmo e quali dettagli sull’utilizzo mancano. L’issue richiede una documentazione di base del codice e contenuti per il README, con una possibile demo di Britecharts; il lavoro è completato quando sono stati aggiunti la documentazione e la spiegazione dell’utilizzo richieste, dopo aver chiarito prima l’ambito di qualsiasi demo.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Valutazione

Stack tecnologico
javascript
Ambito
documentation
Tipo di issue
Documentazione
Difficoltà
3/5
Tempo stimato
1-2 giorni
Stato di attività
Ferma
Chiarezza
Da chiarire
Idoneità per principianti
25/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.