portkey-cloud/portkey

Write a good README

Open

#30 geöffnet am 6. Sept. 2017

Auf GitHub ansehen
 (0 Kommentare) (0 Reaktionen) (0 zugewiesene Personen)Clojure (7 Forks)github user discovery
documentationhelp wanted

Repository-Metriken

Stars
 (146 Stars)
PR-Merge-Metriken
 (PR-Metriken ausstehend)

Beschreibung

Write a README assuming no AWS knowledge that guide the user step by step.

Contributor Guide

Research-Richtung
Untersuche vorhandene READMEs ähnlicher Projekte auf ihre Struktur und schreibe dann eine Schritt für Schritt Anleitung, die Installation, Konfiguration, grundlegende Nutzung und Beispiele für Portkey abdeckt, ohne Vorkenntnisse in AWS vorauszusetzen.
Tech Stack
clojure
Domain
documentation
Issue Type
Dokumentation
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
1
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
1-3 Stunden
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Aktiv
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
Git
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
85