purescript / purescript/trypurescript

Create a dedicated development & release guide

Aperta
#219 1 commento 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Lingua principale
PureScript
Stelle
121
Fork
51
Metriche di merge delle PR
Nessuna PR unita negli ultimi 30g

Descrizione

As discussed in #218, I think we ought to split out the development instructions for Try PureScript from the main README, and we should expand those instructions to include cutting new releases of the project.

The development instructions should cover what they already do: how to set up the local server, how to set up the local client, and how to update the packages and package set.

The release instructions could include things not currently described, including:

  • Updating the hardcoded tag used for examples
  • How to check that the externs for an upgraded package set don't overwhelm the server
  • How to run a deployment

and ideally this could be aggregated in checklist form, so someone who wants to make a release can move step-by-step through the instructions from a fresh clone of the repository.

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

Start with the main README and the discussion in #218, then trace the existing instructions for setting up the local server and client and updating packages and the package set. Done means a dedicated guide with a fresh-clone checklist covering those development steps plus tag updates, externs checks, and deployment.

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

Valutazione

Ambito
documentation, release
Tipo di issue
Documentazione
Difficoltà
4/5
Tempo stimato
3-5 giorni
Stato di attività
Ferma
Chiarezza
Abbastanza chiara
Idoneità per principianti
42/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.