-
Notifications
You must be signed in to change notification settings - Fork 1
#51 Disable rules for commit message and make them optional fixed #62
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
Bumps [@tanstack/react-router](https://github.com/TanStack/router/tree/HEAD/packages/react-router) from 1.106.0 to 1.109.2. - [Release notes](https://github.com/TanStack/router/releases) - [Commits](https://github.com/TanStack/router/commits/v1.109.2/packages/react-router) --- updated-dependencies: - dependency-name: "@tanstack/react-router" dependency-type: direct:production update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] <[email protected]>
…pment/tanstack/react-router-1.109.2 chore(deps): bump @tanstack/react-router from 1.106.0 to 1.109.2
Bumps [react-medium-image-zoom](https://github.com/rpearce/react-medium-image-zoom) from 5.2.13 to 5.2.14. - [Release notes](https://github.com/rpearce/react-medium-image-zoom/releases) - [Changelog](https://github.com/rpearce/react-medium-image-zoom/blob/main/CHANGELOG.md) - [Commits](rpearce/react-medium-image-zoom@v5.2.13...v5.2.14) --- updated-dependencies: - dependency-name: react-medium-image-zoom dependency-type: direct:production update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] <[email protected]>
…pment/react-medium-image-zoom-5.2.14 chore(deps): bump react-medium-image-zoom from 5.2.13 to 5.2.14
Bumps [@tanstack/react-query](https://github.com/TanStack/query/tree/HEAD/packages/react-query) from 5.66.7 to 5.66.8. - [Release notes](https://github.com/TanStack/query/releases) - [Commits](https://github.com/TanStack/query/commits/v5.66.8/packages/react-query) --- updated-dependencies: - dependency-name: "@tanstack/react-query" dependency-type: direct:production update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] <[email protected]>
…pment/tanstack/react-query-5.66.8 chore(deps): bump @tanstack/react-query from 5.66.7 to 5.66.8
Your ehsan patch 1
Create LICENSE
now user will see the warning when they commit if the commit is not according to standard also the default rule for commit message is still mandatory - added code of conduct md - added contributing md - updated the readme
WalkthroughThis pull request updates the commit validation script and several documentation files. In the Changes
Sequence Diagram(s)sequenceDiagram
participant Dev as Developer
participant Hook as Commit-msg Hook
participant Validator as Validation Routine
Dev->>Hook: Initiates commit
Hook->>Validator: Validate commit message
alt Validation fails
Validator-->>Hook: Return error with warning symbol (⚠)
Hook->>Dev: Display warning message
Hook->>Validator: Continue remaining checks
else Validation passes
Validator-->>Hook: All validations passed
end
Hook->>Dev: Proceed with commit process
Possibly related PRs
Poem
🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
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)
Other keywords and placeholders
CodeRabbit Configuration File (
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 1
🧹 Nitpick comments (5)
.husky/commit-msg (2)
38-56: Consider improving warning message readability.The warning message uses multiple blank lines which might make the output verbose. Consider condensing the message while maintaining clarity.
- cat <<EOF -⚠ Commit description is missing! - - -Your commit message must include: -🔹 Header line (type(scope): subject) -🔹 Blank line -🔹 Description (at least 10 characters) - - -✅ Example: -------------------------------------------------------- -fix(auth): resolve login issue - -This commit fixes the authentication system by properly -handling token validation and improving error messages. -------------------------------------------------------- - - -👉 Please add a meaningful description and try again. -EOF + cat <<EOF +⚠ Commit description is missing! + +Your commit message must include: +🔹 Header line (type(scope): subject) +🔹 Blank line +🔹 Description (at least 10 characters) + +✅ Example: +------------------------------------------------------- +fix(auth): resolve login issue + +This commit fixes the authentication system by properly +handling token validation and improving error messages. +------------------------------------------------------- + +👉 Please add a meaningful description and try again. +EOF
67-82: Consider improving warning message readability.Similar to the previous warning message, consider condensing the output for better readability.
- cat <<EOF -⚠ Invalid commit message format! - - -Your commit message must follow this format: -🔹 First line: type(scope): subject -🔹 Second line: BLANK LINE -🔹 Third line onwards: Description (at least 10 characters) - - -Current format: -------------------------------------------------------- -$commit_message -------------------------------------------------------- - - -👉 Please format your commit message correctly and try again. -EOF + cat <<EOF +⚠ Invalid commit message format! + +Your commit message must follow this format: +🔹 First line: type(scope): subject +🔹 Second line: BLANK LINE +🔹 Third line onwards: Description (at least 10 characters) + +Current format: +------------------------------------------------------- +$commit_message +------------------------------------------------------- + +👉 Please format your commit message correctly and try again. +EOFREADME.md (1)
80-80: Add missing comma for better readability.-For more contribution guidelines see [CONTRIBUTING.md](./CONTRIBUTING.md) +For more contribution guidelines, see [CONTRIBUTING.md](./CONTRIBUTING.md)🧰 Tools
🪛 LanguageTool
[uncategorized] ~80-~80: Possible missing comma found.
Context: ...Contributing For more contribution guidelines see [CONTRIBUTING.md](./CONTRIBUTING.md...(AI_HYDRA_LEO_MISSING_COMMA)
CONTRIBUTING.md (1)
101-101: Update Code of Conduct link to reference local file.The Code of Conduct link should point to the local
CODE_OF_CONDUCT.mdfile instead of the generic Contributor Covenant website.-Please follow our [Code of Conduct](https://www.contributor-covenant.org/) to maintain a professional and inclusive environment. +Please follow our [Code of Conduct](./CODE_OF_CONDUCT.md) to maintain a professional and inclusive environment.CODE_OF_CONDUCT.md (1)
62-63: Consider using an organization email for Code of Conduct enforcement.Using a personal email address for Code of Conduct enforcement might not be sustainable long-term. Consider creating a dedicated organization email address (e.g., [email protected]) for this purpose.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
⛔ Files ignored due to path filters (1)
pnpm-lock.yamlis excluded by!**/pnpm-lock.yaml
📒 Files selected for processing (6)
.husky/commit-msg(5 hunks)CODE_OF_CONDUCT.md(1 hunks)CONTRIBUTING.md(1 hunks)LICENSE(1 hunks)README.md(2 hunks)package.json(2 hunks)
✅ Files skipped from review due to trivial changes (2)
- LICENSE
- package.json
🧰 Additional context used
🪛 LanguageTool
README.md
[uncategorized] ~80-~80: Possible missing comma found.
Context: ...Contributing For more contribution guidelines see [CONTRIBUTING.md](./CONTRIBUTING.md...
(AI_HYDRA_LEO_MISSING_COMMA)
CODE_OF_CONDUCT.md
[style] ~32-~32: Try using a synonym here to strengthen your wording.
Context: ...ind - Trolling, insulting or derogatory comments, and personal or political attacks - Pu...
(COMMENT_REMARK)
CONTRIBUTING.md
[style] ~50-~50: Consider shortening or rephrasing this to strengthen your wording.
Context: ...win ``` ## Database Migrations If you make changes to the database schema, generate a new mig...
(MAKE_CHANGES)
|
|
||
| fi | ||
|
|
||
| pnpm commit-msg |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
💡 Verification agent
🧩 Analysis chain
Verify the behavior of pnpm commit-msg.
The script calls pnpm commit-msg which might enforce strict rules, potentially overriding the optional nature of the commit message validation.
🏁 Script executed:
#!/bin/bash
# Check if pnpm commit-msg script exists and examine its content
if [ -f "package.json" ]; then
# Extract commit-msg script if defined
jq -r '.scripts["commit-msg"] // empty' package.json
fiLength of output: 98
Action Required: Adjust commit message enforcement to respect optional rules
The current hook in .husky/commit-msg calls pnpm commit-msg, which—based on the package.json configuration—executes commitlint --edit. This means that despite the PR’s objective to make commit rules optional (by removing exit commands and converting errors to warnings), commitlint is still being invoked in a way that could fail commits on validation errors.
- Line 85: Calling
pnpm commit-msgeffectively enforces strict commit message validation via commitlint. - Lines 38-56 & 67-82: Review the warning message formatting to ensure it aligns with the optional validation behavior.
Please update the hook or commitlint configuration so that commit validation issues are reported as warnings only, without blocking commits.
Summary by CodeRabbit