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

Foundations: Update the description of what a good commit message explains #29001

Open
3 tasks done
Maddily opened this issue Oct 24, 2024 · 1 comment
Open
3 tasks done
Labels
Status: Stale This issue/PR has been inactive for over 30 days and will be closed if inactivity continues

Comments

@Maddily
Copy link
Contributor

Maddily commented Oct 24, 2024

Checks

Describe your suggestion

In the Commit Messages lesson, it's mentioned twice that a commit message should describe both the problem a change solves and how it solves it. I believe the 'how' part may be unnecessary.

In other words, a commit message describes what problem your changes solve and how it solves them.

Describe the problem your commit solves and how.

The article How to Write a Git Commit Message, listed in the assignment section, emphasizes that commit messages should focus on why a change is made, not how, as the code itself shows how the problem is solved. I agree with this point.

Let me know if you agree that the relevant sections of the lesson should be updated.

Path

Foundations

Lesson Url

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

(Optional) Discord Name

Maddie

(Optional) Additional Comments

No response

@Maddily Maddily changed the title Foundations: Update the description of what a good commit message does Foundations: Update the description of what a good commit message explains Oct 24, 2024
Copy link

This issue is stale because it has had no activity for the last 30 days.

@github-actions github-actions bot added the Status: Stale This issue/PR has been inactive for over 30 days and will be closed if inactivity continues label Nov 24, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Status: Stale This issue/PR has been inactive for over 30 days and will be closed if inactivity continues
Projects
None yet
Development

No branches or pull requests

1 participant