TheOdinProject / curriculum

The open curriculum for learning web development
https://www.theodinproject.com/
Other
9.99k stars 13.35k forks source link

Commit Messages: Rephrase sentence for clarity #26723

Closed Gwynim closed 11 months ago

Gwynim commented 11 months ago

Describe your suggestion

There is a typo in the additional resources section - "While the Yarn and creating releases information might not be immediately necessary for Foundations, you don’t need to worry about it for now. So, feel free to explore and enhance your commit messages and development workflow."

The bold section does not complete the part of its sentence before the comma, nor does it effectively transition into the following sentence. There is missing information on the importance of mentioning Yarn and creating releases, such as if this information is relevant for future lessons or use cases outside The Odin Project.

Path

Foundations

Lesson Url

https://www.theodinproject.com/lessons/foundations-commit-messages

Checks

(Optional) Discord Name

No response

(Optional) Additional Comments

No response

MaoShizhong commented 11 months ago

Agreed. In fact, I feel that entire paragraph is quite strangely worded:

Explore this amazing tutorial video on Conventional Commits ➔ Full Video Link. The video showcases best commit message practices, including Yarn (a package manager) and creating releases. While the Yarn and creating releases information might not be immediately necessary for Foundations, you don’t need to worry about it for now. So, feel free to explore and enhance your commit messages and development workflow.

I feel something more along the lines of

Explore this amazing tutorial video on Conventional Commits ➔ Full Video Link. The video showcases the Conventional Commits template from the resource above. It also mentions creating releases and shows using something called "Yarn". These two parts are out of scope for this part of the course, so don't worry about them and instead focus on the commit template.

would be more appropriately worded, given the context it's in.

JoshDevHub commented 11 months ago

I agree this is worded strangely.

What you've changed it to in your message above reads quite nicely though @MaoShizhong. Since the OP has indicated they don't want to work on this, would you be interested in making the change?

MaoShizhong commented 11 months ago

@JoshDevHub If OP doesn't want to them I'll happily make the change. It'll be a quick PR to open for review

JoshDevHub commented 11 months ago

I've assigned you @MaoShizhong :rocket: