Skip to content

Commit cddb7d6

Browse files
authored
fix: multiple typos of different importance
This pull request addresses several typos and minor grammatical inconsistencies found across multiple files in the repository. The fixes aim to improve clarity, readability, and maintain consistency in the project's documentation and workflows. ### Key Changes: - **`.github/ISSUE_TEMPLATE/bug_report.yml`**: - Fixed grammatical issues in descriptions and labels. - **`.github/ISSUE_TEMPLATE/enhancement.yml`**: - Corrected label text and standardized phrasing. - **`.github/ISSUE_TEMPLATE/feature_request.yml`**: - Improved label consistency and readability. - **`.github/pull_request_template.md`**: - Enhanced phrasing and corrected minor grammatical errors. - **`.github/workflows/ci.yml`**: - Adjusted text to ensure consistent phrasing and clarity in workflow steps. These updates ensure a more professional and coherent presentation across the project documentation and workflows. Pull-Request: #5756.
1 parent bd710df commit cddb7d6

File tree

5 files changed

+12
-12
lines changed

5 files changed

+12
-12
lines changed

.github/ISSUE_TEMPLATE/bug_report.yml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ body:
99
- type: textarea
1010
attributes:
1111
label: Summary
12-
description: Please provide a short summary of the bug, along with any information you feel relevant to replicate the bug.
12+
description: Please provide a short summary of the bug, along with any information you feel is relevant to replicate the bug.
1313
validations:
1414
required: true
1515
- type: textarea
@@ -34,7 +34,7 @@ body:
3434
- type: textarea
3535
attributes:
3636
label: Possible Solution
37-
description: Suggest a fix/reason for the bug, or ideas how to implement the addition or change.
37+
description: Suggest a fix/reason for the bug, or ideas on how to implement the addition or change.
3838
validations:
3939
required: false
4040
- type: textarea
@@ -45,11 +45,11 @@ body:
4545
required: false
4646
- type: dropdown
4747
attributes:
48-
label: Would you like to work on fixing this bug ?
48+
label: Would you like to work on fixing this bug?
4949
description: Any contribution towards fixing the bug is greatly appreciated. We are more than happy to provide help on the process.
5050
options:
5151
- "Yes"
5252
- "No"
5353
- Maybe
5454
validations:
55-
required: true
55+
required: true

.github/ISSUE_TEMPLATE/enhancement.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,11 +21,11 @@ body:
2121
required: true
2222
- type: dropdown
2323
attributes:
24-
label: Are you planning to do it yourself in a pull request ?
24+
label: Are you planning to do it yourself in a pull request?
2525
description: Any contribution is greatly appreciated. We are more than happy to provide help on the process.
2626
options:
2727
- "Yes"
2828
- "No"
2929
- Maybe
3030
validations:
31-
required: true
31+
required: true

.github/ISSUE_TEMPLATE/feature_request.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -32,11 +32,11 @@ body:
3232
required: false
3333
- type: dropdown
3434
attributes:
35-
label: Are you planning to do it yourself in a pull request ?
35+
label: Are you planning to do it yourself in a pull request?
3636
description: Any contribution is greatly appreciated. We are more than happy to provide help on the process.
3737
options:
3838
- "Yes"
3939
- "No"
4040
- Maybe
4141
validations:
42-
required: true
42+
required: true

.github/pull_request_template.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ This section will appear as the commit message after merging.
66
Please craft it accordingly.
77
For a quick primer on good commit messages, check out this blog post: https://cbea.ms/git-commit/
88
9-
Please include any relevant issues in here, for example:
9+
Please include any relevant issues here, for example:
1010
1111
Related https://github.com/libp2p/rust-libp2p/issues/ABCD.
1212
Fixes https://github.com/libp2p/rust-libp2p/issues/XYZ.
@@ -15,7 +15,7 @@ Fixes https://github.com/libp2p/rust-libp2p/issues/XYZ.
1515
## Notes & open questions
1616

1717
<!--
18-
Any notes, remarks or open questions you have to make about the PR which don't need to go into the final commit message.
18+
Any notes, remarks, or open questions you have to make about the PR that don't need to go into the final commit message.
1919
-->
2020

2121
## Change checklist

.github/workflows/ci.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,7 @@ jobs:
6767
6868
echo "CRATE_VERSION=$CRATE_VERSION" >> $GITHUB_ENV
6969
70-
- name: Enforce version in `workspace.dependencies` matches latest version
70+
- name: Enforce version in `workspace.dependencies` matches the latest version
7171
if: env.CRATE != 'libp2p'
7272
run: |
7373
SPECIFIED_VERSION=$(tq "workspace.dependencies.$CRATE.version" --file ./Cargo.toml)
@@ -77,7 +77,7 @@ jobs:
7777
7878
test "$CRATE_VERSION" = "$SPECIFIED_VERSION" || test "=$CRATE_VERSION" = "$SPECIFIED_VERSION"
7979
80-
- name: Enforce version in CHANGELOG.md matches version in manifest
80+
- name: Enforce version in CHANGELOG.md matches the version in manifest
8181
run: |
8282
MANIFEST_PATH=$(cargo metadata --format-version=1 --no-deps | jq -e -r '.packages[] | select(.name == "'"$CRATE"'") | .manifest_path')
8383
DIR_TO_CRATE=$(dirname "$MANIFEST_PATH")

0 commit comments

Comments
 (0)