unisonweb/unison

Revamp README

Open

#832 geöffnet am 1. Okt. 2019

Auf GitHub ansehen
 (3 Kommentare) (0 Reaktionen) (0 zugewiesene Personen)Haskell (304 Forks)batch import
documentationhelp wanted

Repository-Metriken

Stars
 (6.624 Stars)
PR-Merge-Metriken
 (Durchschn. Merge 10T 2h) (5 gemergte PRs in 30 T)

Beschreibung

README is kinda out of date and could use a refresh. Let’s use this ticket to discuss ideas for what should go in it. Would someone like to take a crack at proposing an outline?

One thing to keep in mind is that we have both the website and the README, so let’s not duplicate content that’s already on the website. README can certainly point to the website.

Prompted by #831

Contributor Guide

Research-Richtung
Lies die drei vorhandenen Kommentare zu diesem Issue, um die Diskussionspunkte zu verstehen. Sieh dir die aktuelle README Datei im Repository an (wahrscheinlich im Stammverzeichnis). Verstehe die Trennung der Zuständigkeiten zwischen der README und der Projektwebsite. Schlage einen strukturierten Entwurf für die neue README vor, berücksichtige dabei die Diskussion und vermeide Doppelungen mit der Website.
Tech Stack
Keine
Domain
documentation
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.
Klar
Voraussetzungen
Familiarity with UnisonDocumentation writing skills
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
60