TheOdinProject / curriculum

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

Foundations: git commit without m option should be introduced in Commit Messages lesson #28471

Closed nguyenlekhtn closed 2 weeks ago

nguyenlekhtn commented 1 month ago

Checks

Describe your suggestion

In previous lessons, learners are told to use git commit -m <commit message> to commit. In the Commit Messages lesson, a "commit with a body" concept is introduced, but the lesson doesn't explain how to make it. That led to a bunch of questions in our server asking how to do that.

In my opinion, the Commit Messages lessons should mention git commit without m flag, which will open the Git Editor set by the user in Git Basics lesson, and the lesson should also remind user to set git editor in case learners missed that and saw vi opened instead.

Path

Foundations

Lesson Url

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

(Optional) Discord Name

haru => {haru:}

(Optional) Additional Comments

No response

MaoShizhong commented 1 month ago

Sounds sensible to me. Perhaps also adding a quick link to and reminder about changing the commit editor from Git Basics to make sure learners have changed it to VS Code.

I'll assign this to you

KevinMulhern commented 2 weeks ago

Hey @nguyenlekhtn, just checking in, how are you getting on with this? need any help?

nguyenlekhtn commented 2 weeks ago

Hey @nguyenlekhtn, just checking in, how are you getting on with this? need any help?

Hi @KevinMulhern , sorry for delaying, I just made the PR https://github.com/TheOdinProject/curriculum/pull/28655