From 07227c996bc2aad666f163384219e655069f7a0e Mon Sep 17 00:00:00 2001 From: a3hadi Date: Tue, 12 Mar 2024 11:20:15 -0400 Subject: [PATCH] update development.md Signed-off-by: a3hadi --- development.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/development.md b/development.md index b86c624d..5e594072 100644 --- a/development.md +++ b/development.md @@ -39,7 +39,8 @@ pass in `latest` to fetch the latest version from the remote repository: ./update_examples.sh -u ``` After running the script, create another PR for these changes. Ideally, the update script should only be need to run when a new version is released, i.e. provide a version or `latest` to it, -or when a breaking change is merged before the next release, i.e. provide a commit SHA to it. +or when a breaking change is merged before the next release, i.e. provide a commit SHA to it. If your merged change is a small chore, then it is unnecessary to run the update script as we want to +avoid flooding the commit history with dependency updates. Updating the version may not seem necessary since we are using local references. However, the client prints out information related to the server, which includes the SDK version, which is retrieved from the `go.mod` file.