Must-Do Before Git Commits: Check Changes, Stage, and Commit Message
### The "Golden Three Steps" Before Git Commit Before committing code, you need to verify the changes to avoid accidentally committing sensitive information or incomplete code. The core steps are as follows: **1. Check Changes** Use `git status` to view the project status, distinguishing between "modified but unstaged" and "untracked files." Use `git diff <file>` to check specific modifications (e.g., added/deleted lines), and avoid committing irrelevant content like temporary comments or debug logs. **2. Stage Changes** Use `git add` to stage files for commit. For a single file, use `git add <file>`; for all changes, use `git add .` (proceed with caution to avoid adding unintended files). If staging is incorrect, use `git reset HEAD <file>` to undo. **3. Write Clear Commit Messages** Before using `git commit`, clearly describe the purpose of the changes. For short messages, use `-m "description"` (e.g., "Optimize homepage title"). For complex content, open the text editor (default Vim) to write multi-line messages, ensuring conciseness and meaningfulness. Developing the habit of "checking - staging - writing messages" can prevent error - prone commits and improve team collaboration efficiency.
Read MoreGit Commit Message Guidelines: Why Write a Clear Commit Message?
Have you ever encountered vague Git commit messages like "modified" or "fixed a bug", making it difficult to review the details of changes? Clear commit messages can solve this problem. They serve as a "diary" for code changes, needing to explain "what was done" and "why it was done". There are four key benefits to writing standardized commit messages: quick recall (understand changes even after half a year), team collaboration (members quickly locate feature changes), automated tool support (generate version logs, automatically upgrade version numbers), and rapid bug localization (use `git bisect` to quickly narrow down issues during production problems). Start with simplicity for standardization: at minimum, include a "type + description". Common types include `fix` (bug fixes) and `feat` (new features). For advanced usage, consider the Conventional Commits specification, with the format `<type>[optional scope]: <description>`, which can include a body and footer. Beginners can start with "type + description" and use tools like `cz-cli` for assistance. Spend 10 seconds clarifying the core content before each commit, and consistency will improve code management efficiency.
Read More