Skip to content
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.

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

Fix Typos in release.sh and merge_pr.sh Scripts #4087

Closed
wants to merge 2 commits into from
Closed

Conversation

mdqst
Copy link

@mdqst mdqst commented Nov 24, 2024

Describe your changes

Two typos found in the comments of scripts/release.sh and scripts/merge_pr.sh to improve clarity and accuracy.

Changes:

  1. scripts/release.sh:

    • Comment Update:
      • Before: # update the wasm workspace crate versions (1 fixup)
      • After: # update the wasm workspace crate versions (1 commit)
    • Reason: The term "fixup" does not accurately describe the action performed in this context. The script explicitly commits the changes as a separate commit rather than using the "fixup" strategy. This clarification prevents potential misunderstandings for developers reading the script.
  2. scripts/merge_pr.sh:

    • Comment Update:
      • Before: # A helper to merge e.g. a PR from draft to an RC branch where any neccessary conflicts resolutions are expected to have been trained with rerere.
      • After: # A helper to merge e.g. a PR from draft to an RC branch where any necessary conflict resolutions are expected to have been trained with rerere.
    • Reason: Corrects a misspelling of "necessary" (was "neccessary") and adjusts "conflicts resolutions" to "conflict resolutions" for grammatical correctness.

Importance:

  • Improved Clarity: Developers rely on accurate and precise comments for understanding scripts quickly. Typos or misleading terms can cause confusion.
  • Professionalism: Ensuring comments are grammatically correct and meaningful reflects attention to detail and improves the codebase's readability.

Checklist before merging

  • If this PR has some consensus breaking changes, I added the corresponding breaking:: labels
    • This will require 2 reviewers to approve the changes
  • If this PR requires changes to the docs or specs, a corresponding PR is opened in the namada-docs repo
    • Relevant PR if applies:
  • If this PR affects services such as namada-indexer or namada-masp-indexer, a corresponding PR is opened in that repo

Thank you for reviewing this PR! Love Namada! :)

Copy link

codecov bot commented Nov 24, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 74.58%. Comparing base (5bf522f) to head (8615f30).
Report is 5 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #4087   +/-   ##
=======================================
  Coverage   74.58%   74.58%           
=======================================
  Files         341      341           
  Lines      107484   107484           
=======================================
+ Hits        80166    80169    +3     
+ Misses      27318    27315    -3     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@tzemanovic tzemanovic closed this Nov 26, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants