Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Create a dedicated development & release guide #219

Open
thomashoneyman opened this issue May 25, 2021 · 1 comment
Open

Create a dedicated development & release guide #219

thomashoneyman opened this issue May 25, 2021 · 1 comment

Comments

@thomashoneyman
Copy link
Member

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.

@JordanMartinez
Copy link
Contributor

I think the only thing not described in the current RELEASE.md file are:

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants