Skip to content

Conversation

Sid2169
Copy link

@Sid2169 Sid2169 commented Sep 24, 2025

Enhance the "Squashing commits" section for clarity and detail.

  • Added detailed instructions on editing the commit message after squashing commits.
  • Included an example of the commit message format to guide users in creating a cohesive message.
  • Improved overall structure and flow of the section to enhance user understanding, especially for beginners.
  • Clarified the steps involved in the rebase process, ensuring users know what to expect after saving changes.

This update aims to provide a clearer and more informative guide on squashing commits, making it easier for developers to maintain a tidy Git history.

Because

This PR enhances the clarity and detail of the "Squashing commits" section, making it easier for users to understand the process of squashing commits in Git. It addresses potential confusion for beginners and improves the overall instructional quality of the documentation.

This PR

  • Added detailed instructions on editing the commit message after squashing commits.
  • Included an example of the commit message format to guide users in creating a cohesive message.
  • Improved overall structure and flow of the section to enhance user understanding, especially for beginners.
  • Clarified the steps involved in the rebase process, ensuring users know what to expect after saving changes.

Issue

Additional Information

No additional information at this time.

Pull Request Requirements

  • I have thoroughly read and understand The Odin Project curriculum contributing guide
  • The title of this PR follows the location of change: brief description of change format, e.g. Intro to HTML and CSS lesson: Fix link text
  • The Because section summarizes the reason for this PR
  • The This PR section has a bullet point list describing the changes in this PR
  • If this PR addresses an open issue, it is linked in the Issue section
  • If any lesson files are included in this PR, they have been previewed with the Markdown preview tool to ensure it is formatted correctly
  • If any lesson files are included in this PR, they follow the Layout Style Guide

Enhance the "Squashing commits" section for clarity and detail.

- Added detailed instructions on editing the commit message after squashing commits.
- Included an example of the commit message format to guide users in creating a cohesive message.
- Improved overall structure and flow of the section to enhance user understanding, especially for beginners.
- Clarified the steps involved in the rebase process, ensuring users know what to expect after saving changes.

This update aims to provide a clearer and more informative guide on squashing commits, making it easier for developers to maintain a tidy Git history.
@github-actions github-actions bot added the Content: Git Involves Git content label Sep 24, 2025
@KevinMulhern
Copy link
Member

I don’t think this extra step is needed - Git already shows this exact message in the editor during the rebase, and the original instruction captures that process cleanly without adding noise.

Please open an issue before making this kind of change, so we can discuss if it's worth doing first!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Content: Git Involves Git content

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants