haskell-servant/servant

Add examples of using the streaming combinators to the cookbook

Open

#912 geöffnet am 27. Feb. 2018

Auf GitHub ansehen
 (17 Kommentare) (1 Reaktion) (0 zugewiesene Personen)Haskell (422 Forks)batch import
documentationhelp wantedtutorial

Repository-Metriken

Stars
 (1.953 Stars)
PR-Merge-Metriken
 (Durchschn. Merge 23h 44m) (4 gemergte PRs in 30 T)

Beschreibung

Obvious topics to be covered:

  • generating/reading streams with pipes, conduit, streaming
  • defining custom strategies that e.g use fixed-size chunks and no delimiters for, say, serving files local to the server in a streaming fashion without forcing the client to read it all in memory

Contributor Guide

Research-Richtung
Untersuche die vorhandenen Cookbook Beispiele unter 'doc/cookbook' im servant Repository, um das Muster zu verstehen. Studiere die Dokumentation der Bibliotheken 'pipes', 'conduit' und 'streaming', um zu wissen, wie Streams erzeugt/gelesen werden. Implementiere Beispiele für beide in der Issue genannten Themen, folge dabei der vorhandenen Struktur und stelle sicher, dass der Code kompiliert und die Tests bestehen. Aktualisiere bei Bedarf den Cookbook Index.
Tech Stack
Keine
Domain
documentationbackend
Issue Type
Dokumentation
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
3
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
Halber Tag
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Veraltet
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Meist klar
Voraussetzungen
Haskell knowledgeServant basicsStreaming libraries
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
20