lyft / lyft/coloralgorithm

Could you add some documentation?

Offen
#7 2 Kommentare 3 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

Vorherrschende Sprache
JavaScript
Sterne
235
Forks
45
PR-Merge-Kennzahlen
Keine gemergten PRs in 30 T.

Beschreibung

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. It could make for a nice demo to apply your algorithm to a chart.

Thanks again!

Beitragsleitfaden

Für dieses Repository ist kein Beitragsleitfaden indexiert

Erste Schritte

  1. Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
  3. Forke das Repository und arbeite in einem Branch.
  4. Öffne einen Pull Request, der die Issue-Nummer nennt.

Rechercherichtung

Beginne damit, den JavaScript-Code und die README des Repositorys zu prüfen, um zu ermitteln, was der Algorithmus tut und welche Nutzungsdetails fehlen. Das Issue fordert eine grundlegende Codedokumentation und README-Inhalte sowie möglicherweise eine Britecharts-Demo; als erledigt gilt die Aufgabe, wenn die angeforderte Dokumentation und Nutzungserklärung hinzugefügt wurden und der Umfang einer etwaigen Demo zuvor geklärt wurde.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
javascript
Bereich
documentation
Issue-Typ
Dokumentation
Schwierigkeit
3/5
Geschätzter Aufwand
1-2 Tage
Aktivitätsstatus
Veraltet
Klarheit
Muss geklärt werden
Anfängerfreundlichkeit
25/100

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.