From 6868f5412bfb04de5227c787ae540c574a5d4940 Mon Sep 17 00:00:00 2001 From: Clemens Bastian <8781699+amacado@users.noreply.github.com> Date: Sat, 10 Apr 2021 10:41:30 +0200 Subject: [PATCH] enhance guidelines for drafting a new release --- CONTRIBUTING.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index b86006dd..bab00640 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -335,10 +335,10 @@ We are running a Discord server. You can go here to talk, discuss, and more with
  • Push the branch draft-release
  • Manually trigger the workflow build_icons.yml (which has a workflow_dispatch event trigger) and select the branch draft-release as target branch. This will build a font version of all icons using icomoon and automatically creates a pull request to merge the build result back into draft-release
  • Review and approve the auto-create pull request created by the action of the step above
  • -
  • Create a pull request towards development. Mention the release number in the pull request title and add information about all new icons, fixes, features and enhancements in the description of the pull request. Take the commits as a guideline. It's also a good idea to mention and thank all contributions who participated in the release (take description of #504 as an example).
  • -
  • Wait for review and approval of the pull request (DON'T perform a squash-merge)
  • +
  • Create a pull request towards development. Mention the release number in the pull request title (like "Build preparation for release vMAJOR.MINOR.PATCH) and add information about all new icons, fixes, features and enhancements in the description of the pull request. Take the commits as a guideline. It's also a good idea to mention and thank all contributions who participated in the release (take description of #504 as an example).
  • +
  • Wait for review and approval of the pull request (you can perform a squash-merge)
  • Once merged create a pull request with BASE master and HEAD development. Copy the description of the earlier pull request.
  • Since it was already approved in the 'development' stage a maintainer is allowed to merge it (DON'T perform a squash-merge).
  • Create a new release using vMAJOR.MINOR.PATCH as tag and release title. Use the earlier created description as description of the release.
  • Publishing the release will trigger the npm_publish.yml workflow which will execute a npm publish leading to a updated npm package (vMAJOR.MINOR.PATCH).
  • - \ No newline at end of file +