Skip to content

Commit

Permalink
update release checklist
Browse files Browse the repository at this point in the history
ever changing!
  • Loading branch information
kfarr committed Nov 30, 2023
1 parent 80791f2 commit 369171d
Showing 1 changed file with 10 additions and 3 deletions.
13 changes: 10 additions & 3 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,13 +3,20 @@
We welcome community contributions to 3DStreet.

## Release checklist for this repo:
- Bump the version on package.json & package-lock.json (for example from 0.4.1 to 0.4.2)
- Update CHANGELOG.md with "Major improvement" changes summary (low level commits will be automatically generated by github in a later step) you can see notes of changes since last release on [this view](https://github.com/3DStreet/3dstreet/releases/tag/0.4.1)
- After all testing is done and things work well enough for a release.
- Bump the version on package.json & package-lock.json (for example from 0.4.2 to 0.4.4)
- Re-run npm run dist (rerun the build, it hardcodes the version into global var used for console log)
- Commit this all to the repo
- Create a new release here: https://github.com/3DStreet/3dstreet/releases/new. Choose a tag, type in the new version such as "0.4.2" and for the title simply use the new version such as "0.4.2". Click "generate release notes." Copy and paste the "Major improvements" from the above summary above the generated release notes below.
- Use command line to create new tag for new version `git tag 0.4.4` and `git push --tags`
- Create a new release here: https://github.com/3DStreet/3dstreet/releases/new. Choose the tag you just created. (If needed for the title simply use the new version such as "0.4.4")
- Click to automatically "generate release notes." Consider summarizing a few key changes to put at the top.
- Use those summaries to update CHANGELOG.md in this repo with "Major improvement" changes summary and link to the new release for detailed changes
- Update https://www.3dstreet.org/docs/development/releases/ with summary of major improvements and linking back to the new release on github.
- Then to run npm publish after all github version stuff works

## Updating assets submodule:
- from the repo's root directory run `git submodule update --remote` to update the assets submodule

## Contribution Instructions
* fork the repo
* make your contribution
Expand Down

0 comments on commit 369171d

Please sign in to comment.