Skip to content

Commit

Permalink
fix: multiple typos of different importance
Browse files Browse the repository at this point in the history
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.
  • Loading branch information
crStiv authored Dec 23, 2024
1 parent bd710df commit cddb7d6
Show file tree
Hide file tree
Showing 5 changed files with 12 additions and 12 deletions.
8 changes: 4 additions & 4 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ body:
- type: textarea
attributes:
label: Summary
description: Please provide a short summary of the bug, along with any information you feel relevant to replicate the bug.
description: Please provide a short summary of the bug, along with any information you feel is relevant to replicate the bug.
validations:
required: true
- type: textarea
Expand All @@ -34,7 +34,7 @@ body:
- type: textarea
attributes:
label: Possible Solution
description: Suggest a fix/reason for the bug, or ideas how to implement the addition or change.
description: Suggest a fix/reason for the bug, or ideas on how to implement the addition or change.
validations:
required: false
- type: textarea
Expand All @@ -45,11 +45,11 @@ body:
required: false
- type: dropdown
attributes:
label: Would you like to work on fixing this bug ?
label: Would you like to work on fixing this bug?
description: Any contribution towards fixing the bug is greatly appreciated. We are more than happy to provide help on the process.
options:
- "Yes"
- "No"
- Maybe
validations:
required: true
required: true
4 changes: 2 additions & 2 deletions .github/ISSUE_TEMPLATE/enhancement.yml
Original file line number Diff line number Diff line change
Expand Up @@ -21,11 +21,11 @@ body:
required: true
- type: dropdown
attributes:
label: Are you planning to do it yourself in a pull request ?
label: Are you planning to do it yourself in a pull request?
description: Any contribution is greatly appreciated. We are more than happy to provide help on the process.
options:
- "Yes"
- "No"
- Maybe
validations:
required: true
required: true
4 changes: 2 additions & 2 deletions .github/ISSUE_TEMPLATE/feature_request.yml
Original file line number Diff line number Diff line change
Expand Up @@ -32,11 +32,11 @@ body:
required: false
- type: dropdown
attributes:
label: Are you planning to do it yourself in a pull request ?
label: Are you planning to do it yourself in a pull request?
description: Any contribution is greatly appreciated. We are more than happy to provide help on the process.
options:
- "Yes"
- "No"
- Maybe
validations:
required: true
required: true
4 changes: 2 additions & 2 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ This section will appear as the commit message after merging.
Please craft it accordingly.
For a quick primer on good commit messages, check out this blog post: https://cbea.ms/git-commit/
Please include any relevant issues in here, for example:
Please include any relevant issues here, for example:
Related https://github.com/libp2p/rust-libp2p/issues/ABCD.
Fixes https://github.com/libp2p/rust-libp2p/issues/XYZ.
Expand All @@ -15,7 +15,7 @@ Fixes https://github.com/libp2p/rust-libp2p/issues/XYZ.
## Notes & open questions

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

## Change checklist
Expand Down
4 changes: 2 additions & 2 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@ jobs:
echo "CRATE_VERSION=$CRATE_VERSION" >> $GITHUB_ENV
- name: Enforce version in `workspace.dependencies` matches latest version
- name: Enforce version in `workspace.dependencies` matches the latest version
if: env.CRATE != 'libp2p'
run: |
SPECIFIED_VERSION=$(tq "workspace.dependencies.$CRATE.version" --file ./Cargo.toml)
Expand All @@ -77,7 +77,7 @@ jobs:
test "$CRATE_VERSION" = "$SPECIFIED_VERSION" || test "=$CRATE_VERSION" = "$SPECIFIED_VERSION"
- name: Enforce version in CHANGELOG.md matches version in manifest
- name: Enforce version in CHANGELOG.md matches the version in manifest
run: |
MANIFEST_PATH=$(cargo metadata --format-version=1 --no-deps | jq -e -r '.packages[] | select(.name == "'"$CRATE"'") | .manifest_path')
DIR_TO_CRATE=$(dirname "$MANIFEST_PATH")
Expand Down

0 comments on commit cddb7d6

Please sign in to comment.