ci(commmitlint): modify the commitlint tool submission limit

[zzcr]

PR

PR Checklist

Please check if your PR fulfills the following requirements:

• The commit message follows our Commit Message Guidelines
• Tests for the changes have been added (for bug fixes / features)
• Docs have been added / updated (for bug fixes / features)

PR Type

What kind of change does this PR introduce?

• Bugfix
• Feature
• Code style update (formatting, local variables)
• Refactoring (no functional changes, no api changes)
• Build related changes
• CI related changes
• Documentation content changes
• Other... Please describe:

What is the current behavior?

Issue Number: N/A

What is the new behavior?

Does this PR introduce a breaking change?

• Yes
• No

Other information

Summary by CodeRabbit

• Chores
  • Updated commit linting configuration to enforce a maximum header length of 150 characters, enhancing commit message consistency.

[coderabbitai]

Walkthrough

The changes involve an update to the commitlint.config.js file, where a new rules section has been added. This section introduces a rule named 'header-max-length', which sets a warning level for commit headers exceeding 150 characters. The modification aims to enforce a standard for commit message lengths, thereby refining the commit linting process.

Changes

File	Change Summary
commitlint.config.js	Added a new rules section to enforce a maximum commit header length of 150 characters with a warning level.

Poem

In the land of commits, oh so bright,
A rule was added, a guiding light.
"Headers must be short," the rabbit proclaimed,
"Fifteen zero characters, let it be named!"
With linting in place, our messages sing,
A tidy repository, oh what joy it will bring! 🐇✨

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ 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.
  • Generate unit testing code for this file.
  • 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 generate unit testing code for this file.
  • @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 generate unit testing code.
  • @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.

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 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]

[e2e-test-warn]
The component to be tested is missing.

The title of the Pull request should look like "fix(vue-renderless): [action-menu, alert] fix xxx bug".

Please make sure you've read our contributing guide

[coderabbitai]

Actionable comments posted: 0

🧹 Outside diff range and nitpick comments (1)

commitlint.config.js (1)

1-6: Consider adding more commit message rules.

While setting a maximum length is good, consider adding more rules to ensure high-quality commit messages:

 module.exports = {
   extends: ['@commitlint/config-conventional'],
   rules: {
-    'header-max-length': [1, 'always', 150]
+    'header-max-length': [1, 'always', 150],
+    'body-max-line-length': [1, 'always', 100],
+    'subject-case': [2, 'always', 'lower-case'],
+    'type-enum': [2, 'always', [
+      'feat', 'fix', 'docs', 'style', 'refactor',
+      'perf', 'test', 'build', 'ci', 'chore', 'revert'
+    ]]
   }
 }

These additional rules will:

• Enforce line length in commit body
• Ensure consistent case in commit subjects
• Restrict commit types to a predefined set

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between d8a2eac and 6cb4a29.

📒 Files selected for processing (1)

• commitlint.config.js (1 hunks)

🔇 Additional comments (2)

commitlint.config.js (2)

2-2: LGTM! Good practice using conventional commit standard.

Extending @commitlint/config-conventional ensures adherence to the widely-adopted Conventional Commits specification.

---

3-5: 🛠️ Refactor suggestion

Consider stricter enforcement and shorter limit for commit messages.

The current configuration has two potential issues:

1. Using warning level (1) instead of error level (2) means developers can still submit commits exceeding the limit
2. 150 characters is quite lenient - conventional git practices typically recommend 50-72 characters for better readability

Consider this stricter configuration:

  rules: {
-   'header-max-length': [1, 'always', 150]
+   'header-max-length': [2, 'always', 72]
  }

Let's analyze the current commit history to understand the impact: