unisonweb/unison

Revamp README

Open

#832 aperta il 1 ott 2019

Vedi su GitHub
 (3 commenti) (0 reazioni) (0 assegnatari)Haskell (304 fork)batch import
documentationhelp wanted

Metriche repository

Star
 (6624 star)
Metriche merge PR
 (Merge medio 10g 2h) (5 PR mergiate in 30 g)

Descrizione

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

Guida contributor

Direzione di ricerca
Leggi i tre commenti esistenti su questo issue per i punti di discussione. Guarda il file README attuale nel repository (probabilmente nella root). Comprendi la separazione delle responsabilità tra il README e il sito web del progetto. Proponi una struttura delineata per il nuovo README, tenendo conto della discussione ed evitando duplicazioni con il sito web.
Tech stack
Nessuno
Dominio
documentation
Tipo issue
Documentazione
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
3
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
Mezza giornata
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Datata
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
Familiarity with UnisonDocumentation writing skills
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
60