Skip to content

docs: add instructions for splitting changes into multiple commits us…#16

Merged
Rasic2 merged 1 commit intomasterfrom
dev/zhouh
Nov 2, 2025
Merged

docs: add instructions for splitting changes into multiple commits us…#16
Rasic2 merged 1 commit intomasterfrom
dev/zhouh

Conversation

@Rasic2
Copy link
Owner

@Rasic2 Rasic2 commented Nov 2, 2025

…ing git add -p

Summary by CodeRabbit

  • Documentation
    • Added a detailed guide on committing granular changes using interactive staging, including step-by-step instructions, user prompts, and verification methods.

@github-actions github-actions bot added the documentation Improvements or additions to documentation label Nov 2, 2025
@Rasic2 Rasic2 merged commit a1da979 into master Nov 2, 2025
8 checks passed
@coderabbitai
Copy link

coderabbitai bot commented Nov 2, 2025

Caution

Review failed

The pull request is closed.

Walkthrough

This pull request adds documentation to the Git development guide explaining how to split multiple changes within a single file into separate commits using interactive staging (git add -p). The new content includes step-by-step instructions, command prompts, available options, and verification steps via git log.

Changes

Cohort / File(s) Summary
Git workflow documentation
docs/source/development/git.md
Adds comprehensive guide on splitting single-file changes into multiple commits using interactive staging, positioned between existing "版本回退" and "规范 Git 提交说明" sections

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~8 minutes

  • Verify accuracy of git add -p command options and interaction flow
  • Confirm example workflow is complete and reproducible
  • Check that placement and formatting integrate well with existing documentation structure

Poem

🐰 A rabbit hops through Git's fine art,
Splitting changes, line by line apart—
With -p for staging, step by step so clear,
Multiple commits bring order here! 🌱

✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch dev/zhouh

📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between e0d0a2f and 06a90b6.

📒 Files selected for processing (1)
  • docs/source/development/git.md (1 hunks)

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@github-actions github-actions bot added documentation Improvements or additions to documentation and removed documentation Improvements or additions to documentation labels Nov 2, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant