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

Update README.md #24240

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Update README.md #24240

wants to merge 1 commit into from

Conversation

NaifABM
Copy link

@NaifABM NaifABM commented Apr 23, 2024

The word "stand-alone" has been changed to "standalone" to promote more consistency when using compound adjectives. To better reflect its widespread usage as a single term, "home page" has also been changed to "homepage." To properly identify "Swiss Army" as a proper noun, the expression "swiss army knife" has been modified to "Swiss Army knife." To guarantee appropriate hyphenation in compound adjectives, "Platform-specific" has been standardized to "platform-specific."

This is my PR requests for the Software Engineering Assignment with @bbbrumley.

Checklist
  • documentation is added or updated

The word "stand-alone" has been changed to "standalone" to promote more consistency when using compound adjectives. To better reflect its widespread usage as a single term, "home page" has also been changed to "homepage." To properly identify "Swiss Army" as a proper noun, the expression "swiss army knife" has been modified to "Swiss Army knife." To guarantee appropriate hyphenation in compound adjectives, "Platform-specific" has been standardized to "platform-specific."
@openssl-machine openssl-machine added the hold: cla required The contributor needs to submit a license agreement label Apr 23, 2024
@bbbrumley
Copy link
Contributor

Thanks! This looks OK to me; let's see what the maintainers say.

If they're OK with the change and agree it doesn't require a CLA, the maintainers will want the CLA line in the actual commit message; see the documentation here, particularly the part about "To amend a missing .."

@@ -11,13 +11,13 @@ for the TLS (formerly SSL), DTLS and QUIC (currently client side only)
protocols.

The protocol implementations are based on a full-strength general purpose
cryptographic library, which can also be used stand-alone. Also included is a
cryptographic library, which can also be used standalone. Also included is a
Copy link
Contributor

Choose a reason for hiding this comment

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

Here the adjective stand-alone is being used as a complement, and having the hyphenated form (still the more common form in the Oxford dictionary) reads better to me. (However, I probably would use standalone without the hyphen when placing adjacent to a noun, as in "standalone software")

cryptographic module validated to conform with FIPS standards.

OpenSSL is descended from the SSLeay library developed by Eric A. Young
and Tim J. Hudson.

The official Home Page of the OpenSSL Project is [www.openssl.org].
The official Homepage of the OpenSSL Project is [www.openssl.org].
Copy link
Contributor

Choose a reason for hiding this comment

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

Since it's not a proper noun, we don't really need the capitalised form of homepage

@t8m
Copy link
Member

t8m commented Apr 23, 2024

This would be acceptable with CLA: trivial. Could you please amend the commit message to contain CLA: trivial on a separate line in the commit message body?

@t8m t8m added branch: master Merge to master branch triaged: cleanup The issue/pr deals with cleanup of comments/docs not altering code significantly tests: exempted The PR is exempt from requirements for testing cla: trivial One of the commits is marked as 'CLA: trivial' labels Apr 23, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
branch: master Merge to master branch cla: trivial One of the commits is marked as 'CLA: trivial' hold: cla required The contributor needs to submit a license agreement tests: exempted The PR is exempt from requirements for testing triaged: cleanup The issue/pr deals with cleanup of comments/docs not altering code significantly
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

5 participants