From a55da375ceced12b1c0fbc6ef576f9163001472a Mon Sep 17 00:00:00 2001 From: Norm Date: Thu, 23 Mar 2023 16:33:26 +0000 Subject: [PATCH] make --squash optional and add note about when to use it --- docs/install.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/install.md b/docs/install.md index dec6d00b7..055c5a590 100644 --- a/docs/install.md +++ b/docs/install.md @@ -192,11 +192,11 @@ rc-service foundkey start You can check if the service is running with `rc-service foundkey status`. ### Updating FoundKey -When a new release comes out, simply fetch and merge in the new tag. Here we opt to squash upstream commits as it allows for easy reverts in case something goes wrong. +When a new release comes out, simply fetch and merge in the new tag. If you plan on making additional changes on top of that tag, we suggest using the `--squash` option with `git merge`. ```sh git fetch -t -git merge tags/v13.0.0-preview2 --squash - # you are now on the "next" release +git merge tags/v13.0.0-preview2 +# you are now on the "next" release ``` Now you'll want to update your dependencies and rebuild: