Skip to content

Commit 369171d

Browse files
committed
update release checklist
ever changing!
1 parent 80791f2 commit 369171d

File tree

1 file changed

+10
-3
lines changed

1 file changed

+10
-3
lines changed

CONTRIBUTING.md

+10-3
Original file line numberDiff line numberDiff line change
@@ -3,13 +3,20 @@
33
We welcome community contributions to 3DStreet.
44

55
## Release checklist for this repo:
6-
- Bump the version on package.json & package-lock.json (for example from 0.4.1 to 0.4.2)
7-
- 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)
6+
- After all testing is done and things work well enough for a release.
7+
- Bump the version on package.json & package-lock.json (for example from 0.4.2 to 0.4.4)
88
- Re-run npm run dist (rerun the build, it hardcodes the version into global var used for console log)
99
- Commit this all to the repo
10-
- 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.
10+
- Use command line to create new tag for new version `git tag 0.4.4` and `git push --tags`
11+
- 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")
12+
- Click to automatically "generate release notes." Consider summarizing a few key changes to put at the top.
13+
- Use those summaries to update CHANGELOG.md in this repo with "Major improvement" changes summary and link to the new release for detailed changes
14+
- Update https://www.3dstreet.org/docs/development/releases/ with summary of major improvements and linking back to the new release on github.
1115
- Then to run npm publish after all github version stuff works
1216

17+
## Updating assets submodule:
18+
- from the repo's root directory run `git submodule update --remote` to update the assets submodule
19+
1320
## Contribution Instructions
1421
* fork the repo
1522
* make your contribution

0 commit comments

Comments
 (0)