purescript-contrib / purescript-contrib/setup-purescript
Add documentation explaining the internals
Dieses Issue hat noch niemand übernommen.
- Vorherrschende Sprache
- JavaScript
- Sterne
- 46
- Forks
- 8
- PR-Merge-Kennzahlen
- Keine gemergten PRs in 30 T.
Beschreibung
This project currently doesn't meet the minimum requirements for libraries in the Contributors organization because it doesn't contain any tests or documentation. Lacking tests and documentation means it is harder for new contributors to understand the code and contribute safely.
Beitragsleitfaden
Für dieses Repository ist kein Beitragsleitfaden indexiert
Erste Schritte
- Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
- Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
- Forke das Repository und arbeite in einem Branch.
- Öffne einen Pull Request, der die Issue-Nummer nennt.
Rechercherichtung
Beginne damit, die Implementierung des Repositorys zu lesen und die Interna zu identifizieren, die neue Mitwirkende verstehen müssen; im Issue werden keine Dateien, Einstiegspunkte oder Tests genannt. Als erledigt gilt das Hinzufügen einer Dokumentation, die diese Interna klar erklärt und die genannten Anforderungen an Mitwirkende abdeckt, wobei die angeforderte Testabdeckung separat betrachtet wird.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Bewertung
- Tech-Stack
- github-actions, javascript
- Bereich
- devops, documentation
- Issue-Typ
- Dokumentation
- Schwierigkeit
- 4/5
- Geschätzter Aufwand
- 3-5 Tage
- Aktivitätsstatus
- Veraltet
- Klarheit
- Muss geklärt werden
- Anfängerfreundlichkeit
- 25/100