From be822b4a7c2a56814f018d06db3bd6b471ca3ff9 Mon Sep 17 00:00:00 2001 From: stringscut Date: Thu, 18 Dec 2025 11:36:24 +0800 Subject: [PATCH] chore: improve code comments clarity Signed-off-by: stringscut --- CONTRIBUTING.md | 4 ++-- README.md | 11 +++++------ docs/tutorials/gpg-verify/larger-files.md | 2 +- 3 files changed, 8 insertions(+), 9 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 3d0ccd4f..2fbfd67f 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -82,7 +82,7 @@ Must be one of the following: * **docs**: Documentation only changes * **style**: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc) -When a commit fits multiple types, the list also serves as hierarchy of what type should be used, e.g. if a commit introduces a feature and its tests, it's a `feat`. +When a commit fits multiple types, the list also serves as a hierarchy of what type should be used, e.g. if a commit introduces a feature and its tests, it's a `feat`. If there's a breaking change in this commit, add a `!` to the end of the type, e.g. `feat!`, for easier identification. @@ -144,7 +144,7 @@ Breaking Change section should start with the phrase "BREAKING CHANGE: " followe Similarly, a Deprecation section should start with "DEPRECATED: " followed by a short description of what is deprecated, a blank line, and a detailed description of the deprecation that also mentions the recommended update path. -## Authors +## Authors Any contributor who has in the past had at least one pull request for a code change accepted in this repo may submit a pull request to have their name added to the AUTHORS file. Submissions to the AUTHORS file should be in the format below: diff --git a/README.md b/README.md index ab9f5eaa..55c76324 100755 --- a/README.md +++ b/README.md @@ -5,7 +5,7 @@ Welcome to the official Cartesi documentation repository. This documentation is ## Requirements * Install [Node.js](https://nodejs.org/en/download/) version >= 20.x -* Install [Yarn](https://yarnpkg.com/getting-started/install) version >= 1.5 +* Install [Yarn](https://yarnpkg.com/getting-started/install) version >= 1.5 ## Installation @@ -41,9 +41,9 @@ This repo build is automatically deployed using AWS Amplify. The following branches and pull requests are deployed to the following URLs: -| Branch | URL | -| ------- | ------------------------------- | -| main | https://github.com/cartesi/docs | +| Branch | URL | +| ------ | ------------------------------- | +| main | https://github.com/cartesi/docs | ## Project Structure @@ -54,7 +54,6 @@ The following branches and pull requests are deployed to the following URLs: We welcome contributions to improve the documentation! Please see the [Contributing Guide](./CONTRIBUTING.md) for more details. ## License -This project is licensed under the [Apache 2.0 License]( -https://github.com/cartesi/rollups-contracts/blob/main/LICENSE). +This project is licensed under the [Apache 2.0 License](https://github.com/cartesi/rollups-contracts/blob/main/LICENSE). diff --git a/docs/tutorials/gpg-verify/larger-files.md b/docs/tutorials/gpg-verify/larger-files.md index 17bf7408..19483163 100644 --- a/docs/tutorials/gpg-verify/larger-files.md +++ b/docs/tutorials/gpg-verify/larger-files.md @@ -66,7 +66,7 @@ public roundDuration, parties, drives, - false + false ); } ```