From f60bda657eaa401214864716f898e0e916321cd2 Mon Sep 17 00:00:00 2001 From: nicomiguelino Date: Mon, 20 Oct 2025 14:16:01 -0700 Subject: [PATCH] docs: fix typos in release process section MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit - Remove informal phrasing - Add article "the" before "version" - Improve optional step formatting - Fix version tag typo (v1.0.h6 → v1.0.6) --- README.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index ef6e0e8..882be70 100644 --- a/README.md +++ b/README.md @@ -109,9 +109,9 @@ $ mv signature.rs src/pb_signature.rs This project follows [Semantic Versioning](https://semver.org/) (M.m.p = Major.minor.patch). 1. **Prepare the release:** - - Create a release branch (e.g., `release-M.m.p`, like `release-1.0.6`). This is just a suggestion; you can name the branch as you prefer. - - Update version in `Cargo.toml`, `action.yml`, and `Dockerfile` - - Run `cargo build` to update `Cargo.lock` with the new version. This step is optional but recommended. + - Create a release branch (e.g., `release-M.m.p`, like `release-1.0.6`). + - Update the version in `Cargo.toml`, `action.yml`, and `Dockerfile` + - Run `cargo build` to update `Cargo.lock` with the new version (optional but recommended) 2. **Create and merge the pull request:** - Create a pull request from the release branch to `master` @@ -119,7 +119,7 @@ This project follows [Semantic Versioning](https://semver.org/) (M.m.p = Major.m 3. **Create the GitHub release:** - Make sure that you're on the `master` branch and have pulled the latest changes - - Create a version tag (e.g., `vM.m.p`, like `v1.0.h6`) and push it to GitHub by running: + - Create a version tag (e.g., `vM.m.p`, like `v1.0.6`) and push it to GitHub by running: ```bash git tag vM.m.p git push origin vM.m.p