Skip to content

chore: improve code comments clarity #301

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
stringscut wants to merge 1 commit into
base: main
Choose a base branch
from
Open

chore: improve code comments clarity #301

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down Expand Up @@ -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.


## <a name="authors" \>Authors
## <a name="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:
Expand Down
11 changes: 5 additions & 6 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down Expand Up @@ -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

Expand All @@ -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).


2 changes: 1 addition & 1 deletion docs/tutorials/gpg-verify/larger-files.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@ public
roundDuration,
parties,
drives,
false
false
);
}
```
Expand Down