unisonweb/unison

Revamp README

Open

#832 ouverte le 1 oct. 2019

Voir sur GitHub
 (3 commentaires) (0 réactions) (0 assignés)Haskell (304 forks)batch import
documentationhelp wanted

Métriques du dépôt

Stars
 (6 624 stars)
Métriques de merge PR
 (Merge moyen 10j 2h) (5 PRs mergées en 30 j)

Description

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

Guide contributeur

Direction de recherche
Lisez les trois commentaires existants sur cette issue pour comprendre les points de discussion. Consultez le fichier README actuel dans le dépôt (probablement à la racine). Comprenez la séparation des préoccupations entre le README et le site web du projet. Proposez un plan structuré pour le nouveau README, en tenant compte de la discussion et en évitant les doublons avec le site web.
Stack technique
Aucun
Domaine
documentation
Type d'issue
Documentation
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
3
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
Une demi journée
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Ancienne
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
Familiarity with UnisonDocumentation writing skills
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
60