purescript / purescript/trypurescript
Create a dedicated development & release guide
Nobody has claimed this yet.
- Dominant language
- PureScript
- Stars
- 121
- Forks
- 51
- PR merge metrics
- No merged PRs in 30d
Description
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.
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
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.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation, release
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 42/100