docs: review with AI-7 [skip ci]

Author: laxa1986

README.md

@@ -121,7 +121,7 @@ _There are no required inputs. The action only controls that the combination of
 | npm-visibility              | public            | Used together with env variable `NPM_TOKEN` to publish npm package. Specifies package visibility: public or private (not tested yet). [Example](./docs/artifact-types/npmjs.md)                                                                        |
 | node-version                | 22                | Node.js version to publish npm packages. Default is 22 because it is the highest pre-cached in Ubuntu 24 (latest at time of writing)                                                                                                                   |
 | java-version                | 21                | Java version to use with input `aws-codeartifact-maven`. [Example](./docs/artifact-types/aws-codeartifact-maven.md)                                                                                                                                    |
-| pre-publish-script          |                   | Custom sh script that allows you to update version in arbitrary file(s), not only files governed by build tool (pom.xml, package.json, etc.). In this script you can use variable `$version`. See example in [npmjs](./docs/artifact-types/npmjs.md)   |
+| pre-publish-script          |                   | Custom shell script that allows you to update version in arbitrary file(s), not only files governed by build tool (pom.xml, package.json, etc.). In this script you can use variable `$version`. See example in [npmjs](./docs/artifact-types/npmjs.md)   |
 | release-branches            | (see description) | Semantic-release [branches](https://semantic-release.gitbook.io/semantic-release/usage/configuration#branches), mainly used to support [maintenance releases](./docs/features/maintenance-release.md) and [prereleases](./docs/features/prerelease.md) |
 | release-channel             |                   | Repeat `.releaserc.json` `channel` behavior when `version` is set explicitly. See [floating-tags](./docs/features/floating-tags.md) for details                                                                                                        |
 | release-gh                  | true              | If true, then create a GitHub release                                                                                                                                                                                                                  |

action.yml

@@ -30,7 +30,7 @@ inputs:
     description: 'Required if uploading to S3 (i.e. s3/ directory exists)'
     required: false
   aws-s3-dir:
-    description: 'Allows to specify S3 bucket directory to upload artifacts to. By default just place in `bucket/{repo-name}/{version}/*`'
+    description: 'Allows you to specify S3 bucket directory to upload artifacts to. By default, just place in `bucket/{repo-name}/{version}/*`'
     required: false
   changelog-file:
     description: 'Changelog file path. Pass empty string to disable changelog generation'
@@ -68,7 +68,7 @@ inputs:
     required: false
     default: 'public'
   pre-publish-script:
-    description: 'sh script that allows you to update version in custom file(s), not only files governed by build tool (pom.xml, package.json, etc)'
+    description: 'Shell script that allows you to update version in custom file(s), not only files governed by build tool (pom.xml, package.json, etc)'
     required: false
   release-branches:
     description: 'semantic-release "branches" configuration'
@@ -94,7 +94,7 @@ inputs:
     description: 'Explicit version to use instead of auto-generation'
     required: false
   version-bump:
-    description: 'Allows to bump a version w/o semantic commits'
+    description: 'Allows you to bump a version without semantic commits'
     required: false
 
 runs:
@@ -117,7 +117,7 @@ runs:
       if: inputs.release-gh == 'true' && inputs.dev-release != 'true' && !env.GH_TOKEN
       shell: bash
       run: |
-        echo "Error: env: GH_TOKEN is required to create GH release, you can pass $ {{ github.token }} or PAT" >&2; exit 1
+        echo "Error: env variable GH_TOKEN is required to create GH release, you can pass $ {{ github.token }} or PAT" >&2; exit 1
 
     - name: Validate npm visibility
       if : env.NPM_TOKEN && ! (inputs.npm-visibility == 'public' || inputs.npm-visibility == 'private')

docs/best-practices.md

@@ -1,7 +1,7 @@
 # Best practices
 
 - [Build and Release](#build-and-release)
-- [conventional commits](#conventional-commits)
+- [Conventional commits](#conventional-commits)
 - [Company-specific gha-release wrapper](#company-specific-gha-release-wrapper)
 
 ## Build and Release
@@ -52,7 +52,7 @@ jobs:
       # Build/Package the artifact(s)
 
       - name: Upload artifacts
-        if: inputs.artifacts # no sense to upload artifacts on every push in a feature branch
+        if: inputs.artifacts # no point in uploading artifacts on every push in a feature branch
         uses: actions/upload-artifact@v4
         with: # configure what to upload
 ```
@@ -79,7 +79,7 @@ jobs:
   Release:
     needs: Build
     runs-on: ubuntu-latest
-    environment: release # hold `GH_TOKEN` secret, available only for `main` branch
+    environment: release # holds the `GH_TOKEN` secret, available only for `main` branch
     permissions:
       contents: read # required for checkout
       id-token: write # not always required, only if at some step you assume AWS role via OIDC
@@ -97,7 +97,7 @@ jobs:
           GH_TOKEN: ${{ secrets.GH_TOKEN }} # required to push commit and tags
 ```
 
-## conventional commits
+## Conventional commits
 
 `agilecustoms/release` uses [semantic-release](https://github.com/semantic-release/semantic-release)
 for next version generation. semantic-release has several presets for different commit message conventions.
@@ -135,12 +135,12 @@ Non-default presets require additional npm dependency. This is why in many examp
     npm-extra-deps: conventional-changelog-conventionalcommits@9.1.0
 ``` 
 
-For more details see [semantic commits](./features/semantic-commits.md) 
+For more details see [Semantic commits](./features/semantic-commits.md) 
 
 ## Company-specific gha-release wrapper
 
 In many [examples](./examples) you may some inputs repeat, such as `aws-account`, `aws-region`, `aws-role`.
-You can reduce code reputation by creating your own wrapper around `agilecustoms/release`.
+You can reduce code repetition by creating your own wrapper around `agilecustoms/release`.
 For this just create a new GH repo with single file `action.yml`, see example [gha-release](./examples/gha-release).
 Here you provide company-specific defaults, see comment `# company-specific defaults`.
 For parameters that may vary - you add them in `inputs` section and pass them through, see comment `# pass through inputs`.