Some git commit histories are really embarrassing, I recommend all engineers to frequently use git rebase and git commit --amend

Ji Carl — Sun, 15 Dec 2024 08:10:02 +0000

In daily programming collaboration, the quality of Git commit records often reflects an engineer's engineering literacy. However, I frequently see some non-standard commit records that are quite embarrassing.

For example:

This is likely due to making changes after a commit and casually reusing the previous git commit command.

While this might be acceptable in personal repositories, it's somewhat unprofessional in collaborative repositories.

In my opinion, these commit records are unnecessary, represent bad habits, and can be completely avoided.

Fortunately, Git provides us with an elegant solution. If there's no need to generate a new commit, using git commit --amend can avoid this issue.

Use less `git merge` and more `git rebase`

For example:

Merge branch 'feature-A' of https://github.com/qiniu/reviewbot into feature-B

This indicates merging code from remote branch feature-A into feature-B. Here, feature-A is typically the main branch.

Such commit messages are unnecessary in your PR. PR commit messages should only contain useful information about the current changes.

Personally, I rarely use git merge, even for syncing remote branches, I generally use git rebase.

For example:

Besides the above benefits, git rebase helps maintain a very clean commit history in the main repository. Therefore, I strongly recommend using it.

Reviewbot's git commit check

Reviewbot is an open-source project by Qiniu Cloud, aimed at providing a self-hosted code review service for convenient code review/static analysis and implementation of custom engineering standards.

To better regulate these two behaviors, Reviewbot has added git commit check capability to verify if git commit records meet the standards.

If they don't comply with the standards, Reviewbot will notify you:

More git flow practices and tips

Of course, there are many practical techniques in git operations. I encourage interested individuals to explore them. I shared related content with students during the 1024 training camp:

Super Practical! Git Collaboration from a User's Perspective, Say Goodbye to Rote Memorization

The document includes video links for interested readers.

Finally, as professional engineers, we should always pursue excellence in engineering practices. Good commit records not only reflect personal professional quality but are also an important cornerstone for improving team collaboration efficiency.

Through proper use of git rebase and git commit --amend, we can maintain a clearer, more professional code submission history. This not only makes code review easier but also brings great convenience to subsequent code maintenance and issue tracking.

What do you think?

Reviewbot — Empower Your Code Quality with Self-Hosted Automated Analysis and Review

Ji Carl — Fri, 11 Oct 2024 11:40:03 +0000

Looking to build a self-hosted code review service? Try Reviewbot, now open-sourced!

When do you need a self-hosted code review service?

You might need one when:

You have many repos but still want tight control over code quality
Your repos are private, and commercial services seem overkill
You want to continuously improve the process and rules, with full customization

Benefits of a self-hosted code review service

While many linter tools and engineering practices exist, they're often underutilized:

Powerful tools like golangci-lint (with 100+ integrated linters) are often used with default settings, ignoring most features
Linter outputs get buried in logs, making issue-finding a chore
Configuring CLI-based linters for multiple repos is tedious, especially for ongoing improvements
Monitoring code quality across repos can be daunting

A self-hosted service can automate all this. As a DevOps or QA team member, you can easily centralize control, monitoring, and customization of code quality across all repos.

Enter Reviewbot - your solution for self-hosted code review.

What can Reviewbot do?

Reviewbot helps you quickly set up a self-hosted code analysis and review service, supporting multiple languages and coding standards. It's perfect for organizations with numerous private repos.

Issues are reported during Pull Requests as Review Comments or Github Annotations, pinpointing exact code lines.

Github Check Run (Annotations)

Github Pull Request Review Comments

This approach saves PR authors from sifting through lengthy logs, streamlining problem-solving.

Reviewbot's Design Philosophy

Focused on:

Security - Self-hosting for data control
Improvement-Oriented - Issues reported as Review Comments or Github Annotations for easy fixes
Flexibility - Multi-language support with easy tool integration
Observability - Alert notifications for timely issue awareness
Configurable - Customizable linter commands, parameters, and environments

Built with Golang, Reviewbot boasts simple logic and clear code for easy maintenance.

Main Flow

Reviewbot primarily operates as a GitHub Webhook/App service, accepting GitHub Events, executing various checks, and providing precise feedback on the corresponding code if issues are detected.

Github Event -> Reviewbot -> Execute Linter -> Provide Feedback

And you can easily Add a New Linter or do Customization.

Monitoring Detection Results

Reviewbot supports notification of detection results through WeWork (企业微信) alerts.

If unexpected output is encountered, notifications will also be sent, like this:

Check out Reviewbot's Github page.

Welcome any comments and suggestions.

DEV Community: Ji Carl

Some git commit histories are really embarrassing, I recommend all engineers to frequently use git rebase and git commit --amend

Use less git merge and more git rebase

Reviewbot's git commit check

More git flow practices and tips

Reviewbot — Empower Your Code Quality with Self-Hosted Automated Analysis and Review

When do you need a self-hosted code review service?

Benefits of a self-hosted code review service

What can Reviewbot do?

Reviewbot's Design Philosophy

Main Flow

Monitoring Detection Results

More

Use less `git merge` and more `git rebase`