fix: Split `alignappend` into separate `align` and `append` imperatives by shenxianpeng · Pull Request #321 · commit-check/commit-check

shenxianpeng · 2025-11-04T22:48:22Z

closes #318

Summary by CodeRabbit

New Features
- Expanded commit message imperatives by splitting a combined imperative into two separate, more granular options.

closes #318

coderabbitai · 2025-11-04T22:48:30Z

Walkthrough

The PR resolves issue #318 by clarifying the IMPERATIVES set in commit_check/imperatives.py. The ambiguous single imperative "alignappend" is replaced with two distinct imperatives: "align" and "append", confirming the intended behavior was to support both commands separately.

Changes

Cohort / File(s)	Change Summary
Imperative Set Clarification `commit_check/imperatives.py`	Replaced "alignappend" with "align" and "append" in the `IMPERATIVES` set; increases set cardinality by one and allows both commands as separate imperatives.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Verify that no other code or tests depend on "alignappend" as a single imperative string
Confirm that existing tests pass with the expanded imperative set
Validate the change aligns with the intended commit message conventions

Poem

🐰 A typo caught, a rabbit's delight!
Two words emerge from tangled night—
"Align" and "append," now clean and bright,
The imperatives shine with newfound light! ✨

Pre-merge checks and finishing touches

✅ Passed checks (4 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Linked Issues check	✅ Passed	The PR successfully addresses issue #318 by replacing the ambiguous 'alignappend' with two separate imperatives 'align' and 'append', resolving the question about whether it was a typo.
Out of Scope Changes check	✅ Passed	All changes are directly related to issue #318; the replacement of 'alignappend' with 'align' and 'append' is the only modification made.
Title check	✅ Passed	The PR title clearly identifies the main change: splitting the single imperative 'alignappend' into two separate ones ('align' and 'append'), which directly addresses the core modification.

✨ Finishing touches

📝 Generate docstrings

🧪 Generate unit tests (beta)

Create PR with unit tests
Post copyable unit tests in a comment
Commit unit tests in branch bugfix/update-imperatives

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.}

netlify · 2025-11-04T22:48:41Z

✅ Deploy Preview for commit-check ready!

Name	Link
🔨 Latest commit	`3ca2639`
🔍 Latest deploy log	https://app.netlify.com/projects/commit-check/deploys/690a833eed728a000797eab2
😎 Deploy Preview	https://deploy-preview-321--commit-check.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

codecov · 2025-11-04T22:49:47Z

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 87.26%. Comparing base (e8a6f91) to head (3ca2639).
⚠️ Report is 1 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff             @@
##             main     #321      +/-   ##
==========================================
+ Coverage   87.15%   87.26%   +0.10%     
==========================================
  Files           8        8              
  Lines         685      683       -2     
==========================================
- Hits          597      596       -1     
+ Misses         88       87       -1

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

sonarqubecloud · 2025-11-04T22:51:04Z

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

coderabbitai

Actionable comments posted: 1

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between e8a6f91 and 8287e0e.

📒 Files selected for processing (1)

commit_check/imperatives.py (1 hunks)

🧰 Additional context used

🧠 Learnings (1)

📓 Common learnings

Learnt from: CR
Repo: commit-check/commit-check PR: 0
File: .github/copilot-instructions.md:0-0
Timestamp: 2025-10-03T10:28:06.793Z
Learning: Applies to commit_check/commit.py : Support breaking change notation with ! (e.g., feat!: breaking change)

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (18)

GitHub Check: install (3.14, ubuntu-24.04)
GitHub Check: install (3.13, windows-latest)
GitHub Check: install (3.11, macos-latest)
GitHub Check: install (3.14, windows-latest)
GitHub Check: install (3.12, ubuntu-24.04)
GitHub Check: install (3.12, windows-latest)
GitHub Check: install (3.13, ubuntu-24.04)
GitHub Check: install (3.11, ubuntu-24.04)
GitHub Check: install (3.13, macos-latest)
GitHub Check: install (3.10, windows-latest)
GitHub Check: install (3.10, macos-latest)
GitHub Check: install (3.12, macos-latest)
GitHub Check: install (3.11, windows-latest)
GitHub Check: install (3.9, windows-latest)
GitHub Check: install (3.9, ubuntu-24.04)
GitHub Check: install (3.10, ubuntu-24.04)
GitHub Check: install (3.9, macos-latest)
GitHub Check: Run benchmarks

commit_check/imperatives.py

codspeed-hq · 2025-11-04T22:53:29Z

CodSpeed Performance Report

Merging #321 will degrade performances by 39.71%

_{Comparing bugfix/update-imperatives (3ca2639) with main (653cea1)¹}

Summary

❌ 1 regression
✅ 155 untouched
⏩ 85 skipped²

⚠️ Please fix the performance issues or acknowledge them on CodSpeed.

Benchmarks breakdown

	Benchmark	`BASE`	`HEAD`	Change
❌	`test_main_with_message_empty_string_no_stdin_with_git`	4.7 ms	7.7 ms	-39.71%

No successful run was found on main (e8a6f91) during the generation of this report, so 653cea1 was used instead as the comparison base. There might be some changes unrelated to this pull request in this report. ↩
85 benchmarks were skipped, so the baseline results were used instead. If they were deleted from the codebase, click here and archive them to remove them from the performance reports. ↩

chore: Update imperatives.py

8287e0e

closes #318

shenxianpeng requested a review from a team as a code owner November 4, 2025 22:48

github-actions bot added the bug Something isn't working label Nov 4, 2025

chore: Fix alphabetical ordering of new entries

3ca2639

shenxianpeng changed the title ~~chore: Update imperatives.py~~ fix: Update imperatives.py Nov 4, 2025

coderabbitai bot reviewed Nov 4, 2025

View reviewed changes

commit_check/imperatives.py Show resolved Hide resolved

shenxianpeng changed the title ~~fix: Update imperatives.py~~ fix: Split alignappend into separate align and append imperatives Nov 4, 2025

shenxianpeng merged commit 106ea31 into main Nov 4, 2025
35 checks passed

shenxianpeng deleted the bugfix/update-imperatives branch November 4, 2025 22:56

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

fix: Split `alignappend` into separate `align` and `append` imperatives#321

fix: Split `alignappend` into separate `align` and `append` imperatives#321
shenxianpeng merged 2 commits intomainfrom
bugfix/update-imperatives

shenxianpeng commented Nov 4, 2025 •

edited by coderabbitai bot

Loading

Uh oh!

coderabbitai bot commented Nov 4, 2025 •

edited

Loading

Uh oh!

netlify bot commented Nov 4, 2025 •

edited

Loading

Uh oh!

codecov bot commented Nov 4, 2025 •

edited

Loading

Uh oh!

sonarqubecloud bot commented Nov 4, 2025

Uh oh!

coderabbitai bot left a comment

Uh oh!

Uh oh!

codspeed-hq bot commented Nov 4, 2025 •

edited

Loading

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

Uh oh!

Conversation

shenxianpeng commented Nov 4, 2025 • edited by coderabbitai bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary by CodeRabbit

Uh oh!

coderabbitai bot commented Nov 4, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

Estimated code review effort

Poem

Pre-merge checks and finishing touches

Uh oh!

netlify bot commented Nov 4, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

✅ Deploy Preview for commit-check ready!

Uh oh!

codecov bot commented Nov 4, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

sonarqubecloud bot commented Nov 4, 2025

Quality Gate passed

Uh oh!

coderabbitai bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

codspeed-hq bot commented Nov 4, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

CodSpeed Performance Report

Merging #321 will degrade performances by 39.71%

Summary

Benchmarks breakdown

Footnotes

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

shenxianpeng commented Nov 4, 2025 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Nov 4, 2025 •

edited

Loading

netlify bot commented Nov 4, 2025 •

edited

Loading

codecov bot commented Nov 4, 2025 •

edited

Loading

codspeed-hq bot commented Nov 4, 2025 •

edited

Loading