Create a dedicated development & release guide

Offen

#219 erstellt am 25.5.2021 1 Kommentar 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

Bewertung

Schwierigkeit: 4/5
Geschätzter Aufwand: 3-5 Tage
Anfängerfreundlichkeit: 42/100

Issue-Typ: Dokumentation
Klarheit: Größtenteils klar
Aktivitätsstatus: Veraltet
Bereich: documentation, release

Rechercherichtung

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.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Beschreibung

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.

Vorherrschende Sprache: PureScript
Sterne: 121
Forks: 51
PR-Merge-Kennzahlen: Keine gemergten PRs in 30 T.

Beitragsleitfaden

Für dieses Repository ist kein Beitragsleitfaden indexiert

Erste Schritte

Lesen Sie das ganze Issue und danach den Beitragsleitfaden des Projekts.
Schreiben Sie ins Issue, dass Sie es übernehmen — das erspart doppelte Arbeit.
Forken Sie das Repository und arbeiten Sie in einem Branch.
Öffnen Sie einen Pull Request, der die Issue-Nummer nennt.

Mehr aus purescript/trypurescript

Add options for bare-bones use Offen

Schwierigkeit 5/5 Über eine Woche Anfängerfreundlichkeit 25/100

purescript/trypurescript#309 · Erstellt am 08.5.2023
Code editor is difficult to use in iOS Safari Offen

Schwierigkeit 4/5 3-5 Tage Anfängerfreundlichkeit 35/100

purescript/trypurescript#308 · Erstellt am 08.5.2023
Publish as a library Offen

Schwierigkeit 5/5 Über eine Woche Anfängerfreundlichkeit 25/100

purescript/trypurescript#303 · 1 Kommentar · Erstellt am 31.10.2022
Proposal: Add the es-optimizer as an option for ShowJS Offen

Schwierigkeit 5/5 Über eine Woche Anfängerfreundlichkeit 25/100

purescript/trypurescript#301 · 1 Kommentar · 1 Reaktion · Erstellt am 04.10.2022
User-inputted module's `main` call called twice Offen

Schwierigkeit 3/5 1-2 Tage Anfängerfreundlichkeit 35/100

purescript/trypurescript#293 · 7 Kommentare · Erstellt am 23.7.2022

Alle Issues in purescript/trypurescript