-
Notifications
You must be signed in to change notification settings - Fork 11.8k
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 typo in GUIDELINES.md #5297
Conversation
The word "worklows" should be "workflows".
There is an inconsistency in how the word "responsibly" is used. The phrase "as soon as responsibly possible" is awkward. The more common and grammatically correct expression is "as soon as reasonably possible".
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks!
Co-authored-by: Ernesto García <[email protected]>
Please merge it |
Congrats, your important contribution to this open-source project has earned you a GitPOAP! GitPOAP: 2024 OpenZeppelin Contracts Contributor: Head to gitpoap.io & connect your GitHub account to mint! Learn more about GitPOAPs here. |
Description:
This pull request addresses two issues:
Fix Typo in
GUIDELINES.md
In the
GUIDELINES.md
file, there was a typo in the following sentence:The word "worklows" should be "workflows". This change corrects the typo to:
Importance: Although this is a minor typo, ensuring the correct spelling of terms is important for maintaining the professionalism and clarity of the documentation.
Improve Clarity in
SECURITY.md
In the
SECURITY.md
file, there was an awkward phrasing in the sentence:The phrase "as soon as responsibly possible" is unclear and uncommon. The corrected version uses the more standard and grammatically correct expression:
Importance: This change improves readability and ensures that the documentation uses the correct, widely-understood phrasing. The word "responsibly" in this context was not suitable and could confuse readers.
PR Checklist
npx changeset add
)