Skip to content

README: various improvements #453

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

Merged
merged 1 commit into from
May 3, 2024
Merged

README: various improvements #453

merged 1 commit into from
May 3, 2024

Conversation

cu
Copy link
Contributor

@cu cu commented May 1, 2024

This is sort of a grab-bag of things that I found while reading the README. Each change is fairly small so it seemed best to combine them under one commit.

Because

A few simple changes to make the README more useful and easier to read. In particular, I stumbled over the paragraph about test.skip a couple times before I understood what it meant. The rest of these are just bonus fixes that seemed like a good idea, but ultimately I am not particularly passionate about.

This PR

  • Add link to The Odin Project home page in 1st paragraph.
  • Remove a few contractions. (Contractions are not used consistently here, so it was easier/better to just remove the few that popped up.)
  • Fix some awkward phrasing.

Pull Request Requirements

  • I have thoroughly read and understand The Odin Project Contributing Guide
  • The title of this PR follows the location of change: brief description of change format, e.g. 01_helloWorld: Update test cases
  • The Because section summarizes the reason for this PR
  • The This PR section has a bullet point list describing the changes in this PR
  • [n/a] If this PR addresses an open issue, it is linked in the Issue section
  • [n/a] If this PR includes any changes that affect the solution of an exercise, I've also updated the solution in the /solutions folder

This is sort of a grab-bag of things that I found while reading the README.
Each change is fairly small so it seemed best to combine them under one commit.

* Add link to The Odin Project home page in 1st paragraph.
* Remove a few contractions. (Contractions are not used consitently here,
  so it was easier/better to just remove the few that popped up.)
* Fix some awkward phrasing.
Copy link
Contributor

@MaoShizhong MaoShizhong left a comment

Choose a reason for hiding this comment

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

Some fair verbiage improvements, thanks for contributing.

@MaoShizhong MaoShizhong merged commit 45a5ced into TheOdinProject:main May 3, 2024
Oussama5379 added a commit to Oussama5379/javascript-exercises that referenced this pull request Feb 1, 2025
This is sort of a grab-bag of things that I found while reading the README.
Each change is fairly small so it seemed best to combine them under one commit.

* Add link to The Odin Project home page in 1st paragraph.
* Remove a few contractions. (Contractions are not used consitently here,
  so it was easier/better to just remove the few that popped up.)
* Fix some awkward phrasing.
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