purescript-contrib / purescript-contrib/setup-purescript

Add documentation explaining the internals

Aperta
#5 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

document me help wanted
Lingua principale
JavaScript
Stelle
46
Fork
8
Metriche di merge delle PR
Nessuna PR unita negli ultimi 30g

Descrizione

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.

Guida per i contributori

Nessuna guida per i contributori indicizzata per questo repository

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Direzione di ricerca

Inizia leggendo l’implementazione del repository e identificando gli aspetti interni che i nuovi contributori devono comprendere; l’issue non indica file, punti di ingresso o test. Il lavoro è considerato completato quando viene aggiunta una documentazione che spiega chiaramente questi aspetti interni e affronta i requisiti indicati per i contributori, considerando separatamente la copertura dei test richiesta.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Valutazione

Stack tecnologico
github-actions, javascript
Ambito
devops, documentation
Tipo di issue
Documentazione
Difficoltà
4/5
Tempo stimato
3-5 giorni
Stato di attività
Ferma
Chiarezza
Da chiarire
Idoneità per principianti
25/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.