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 typo in GUIDELINES.md #5297

Merged
merged 3 commits into from
Nov 21, 2024
Merged

Fix typo in GUIDELINES.md #5297

merged 3 commits into from
Nov 21, 2024

Conversation

famouswizard
Copy link
Contributor

Description:

This pull request addresses two issues:

  1. Fix Typo in GUIDELINES.md
    In the GUIDELINES.md file, there was a typo in the following sentence:

    "Automations that make use of sensitive credentials must use secure secret management, and must be strengthened against attacks such as those on GitHub Actions worklows."

    The word "worklows" should be "workflows". This change corrects the typo to:

    "Automations that make use of sensitive credentials must use secure secret management, and must be strengthened against attacks such as those on GitHub Actions workflows."

    Importance: Although this is a minor typo, ensuring the correct spelling of terms is important for maintaining the professionalism and clarity of the documentation.

  2. Improve Clarity in SECURITY.md
    In the SECURITY.md file, there was an awkward phrasing in the sentence:

    "Security vulnerabilities will be patched as soon as responsibly possible, and published as an advisory on this repository (see [advisories]) and on the affected npm packages."

    The phrase "as soon as responsibly possible" is unclear and uncommon. The corrected version uses the more standard and grammatically correct expression:

    "Security vulnerabilities will be patched as soon as reasonably possible, and published as an advisory on this repository (see [advisories]) and on the affected npm packages."

    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

  • Tests
  • Documentation
  • Changeset entry (run npx changeset add)

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".
Copy link

changeset-bot bot commented Nov 14, 2024

⚠️ No Changeset found

Latest commit: b06e3c7

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

Copy link
Member

@ernestognw ernestognw left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks!

SECURITY.md Outdated Show resolved Hide resolved
Co-authored-by: Ernesto García <[email protected]>
@famouswizard
Copy link
Contributor Author

Please merge it

@cairoeth cairoeth changed the title Fix typos and improve clarity in GUIDELINES.md and SECURITY.md Fix typo in GUIDELINES.md Nov 21, 2024
@cairoeth cairoeth merged commit a277d47 into OpenZeppelin:master Nov 21, 2024
17 checks passed
Copy link

gitpoap-bot bot commented Nov 21, 2024

Congrats, your important contribution to this open-source project has earned you a GitPOAP!

GitPOAP: 2024 OpenZeppelin Contracts Contributor:

GitPOAP: 2024 OpenZeppelin Contracts Contributor GitPOAP Badge

Head to gitpoap.io & connect your GitHub account to mint!

Learn more about GitPOAPs here.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants