feat: add imperative mood

[shenxianpeng]

related to #120

Summary by CodeRabbit

• New Features
  • Added an optional parameter to check if commit messages are in the imperative mood, enabled by default.
• Documentation
  • Updated usage examples and documentation to describe the new imperative mood check option.

[coderabbitai]

Warning

Rate limit exceeded

@shenxianpeng has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 20 minutes and 55 seconds before requesting another review.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

📥 Commits

Reviewing files that changed from the base of the PR and between 3044b4a and 62d29cc.

📒 Files selected for processing (4)

• .github/workflows/commit-check.yml (1 hunks)
• README.md (2 hunks)
• action.yml (2 hunks)
• main.py (3 hunks)

Walkthrough

A new optional input parameter, imperative, was introduced across the GitHub Action, its workflow, and documentation. This parameter enables or disables checking whether commit messages are in the imperative mood. The implementation includes updates to the action's metadata, execution environment, workflow configuration, and command-line invocation in the main script.

Changes

File(s)	Change Summary
.github/workflows/commit-check.yml	Added imperative: true input to the self-test action step in the workflow configuration.
README.md	Documented the new imperative input, updated usage example, and described its purpose/default.
action.yml	Introduced imperative input (default: true); set IMPERATIVE env var for action execution.
main.py	Added IMPERATIVE env var; included in env logging; updated command to pass --imperative flag.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant GitHub Actions
    participant Action Runner
    participant main.py

    User->>GitHub Actions: Push/PR triggers workflow
    GitHub Actions->>Action Runner: Run commit-check job (with imperative input)
    Action Runner->>main.py: Set IMPERATIVE env var from input
    main.py->>main.py: Log IMPERATIVE env var
    main.py->>main.py: If IMPERATIVE == "true", add --imperative to commit-check command
    main.py->>Action Runner: Execute commit-check with appropriate flags

Loading

Poem

From bunny paws, a feature hops anew,
"Imperative," it checks your message through!
In YAML and docs, its tale is told,
With env vars set, the logic unfolds.
Now commits are crisp, commands obey—
A rabbit’s wish for a tidy day!
🐇✨

✨ Finishing Touches

• 📝 Generate Docstrings

---

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

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Explain this complex logic.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai explain this code block.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and explain its main purpose.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR.
• @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[github-actions]

Commit-Check ✔️