diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 07b6dfea1..d6430a735 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -3,11 +3,11 @@ We welcome community contributions to 3DStreet. ## Release checklist for this repo: -- Bump the version on package.json & package-lock.json +- Bump the version on package.json & package-lock.json (for example from 0.4.1 to 0.4.2) - update CHANGELOG.md with high level changes only (low level commits will be automatically generated by github later) you can see notes of changes since last release on [this view](https://github.com/3DStreet/3dstreet/releases/tag/0.4.1) - 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 -- How to make a tag and release? +- 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" - Then to run npm publish after all github version stuff works ## Contribution Instructions