From a9920e1502dbd629a6c6c2fa20378341c28e730b Mon Sep 17 00:00:00 2001 From: Tim Welch Date: Fri, 9 Aug 2024 12:47:17 -0700 Subject: [PATCH] update release notes step --- CONTRIBUTING.md | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 067e3005f..533c8b84a 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -240,7 +240,12 @@ Run the following release commands, replacing `7.0.0` with your version number: - Get approval for the release PR and merge it! #### Follow-on steps -- As part of the release action, a draft Github release will have been created at https://github.com/Turfjs/turf/releases with an auto-generated changelog. Edit and add to the release notes for readability and completeness, specifically noting any breaking changes. Use past releases as a guide. Be sure to "Save draft" each time, then ask for a review from other contributors. Once ready, click `Publish release`. This will make the release notes publicly accessible and notify all watchers of the project. +- As part of the release action, a draft Github release will have been created at https://github.com/Turfjs/turf/releases with an auto-generated changelog. + - Edit and add to the release notes for readability and completeness, specifically noting any breaking changes. Use past releases as a guide. + - Be sure to "Save draft" each time, then ask for a review or edits from other contributors. + - Try not to leave the notes unpublished more than a day, people rely on these notes for upgrading. + - Once ready, click `Publish release`. This will make the release notes publicly accessible and notify all watchers of the project. + - You can edit and republish your release notes after this, but that will likely notify followers, so best to get it right the first time. - Release a new version of the [API docs](https://github.com/Turfjs/turf-www/blob/master/CONTRIBUTING.md) for the https://turfjs.org website. ## Documentation