-
Notifications
You must be signed in to change notification settings - Fork 17
docs: fix misleading CI and Label Checker badge status and remove commitlint references from README #45
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
Co-authored-by: 04shubham7 <[email protected]>
Co-authored-by: 04shubham7 <[email protected]>
04shubham7
left a comment
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.
no need of commitlint as i removed it completely from my project only label checker is there
README.md
Outdated
| This project has automated CI/CD workflows that run on every push and pull request: | ||
|
|
||
| #### 🔍 Commitlint (CI Workflow) | ||
| #### 🔍 Commitlint (Local Git Hooks) |
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.
remove commitlint as i have removed this workflow 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.
Removed the commitlint section and all related references. The README now only documents the Label Checker workflow. Commit: ec254b6 (updated)
|
@copilot work on the requested changes |
Co-authored-by: 04shubham7 <[email protected]>
Removed all commitlint references from README including the Commit Message Validation section, Development section examples, and Contributing guidelines. Commit: ec254b6 (updated) |
04shubham7
left a comment
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.
Loooks nice
Problem
The README.md file was displaying two problematic workflow status badges that showed "failing" status, creating confusion about the repository's health:
Additionally, the README contained outdated references to commitlint/conventional commits that are no longer used in the project.
Root Cause
Non-existent CI Badge
The README referenced a workflow named "CI" using the URL pattern:
However, no such workflow exists in
.github/workflows/. The repository only has:checklabels.yaml(Label Checker)prmerged.yaml(On Pull Request Merge)Misleading Label Checker Badge
While the Label Checker workflow exists and functions correctly, its dynamic badge showed "failing" status because:
pull_requestevents, not on the main branchOutdated Commitlint References
The README documented commitlint/conventional commits validation, but this has been removed from the project.
Solution
Removed Dynamic Workflow Badges
Removed both problematic badges and kept only the static informational badges:
These static badges provide accurate, consistent information without the confusion caused by dynamic workflow status badges.
Removed Commitlint Documentation
Per maintainer feedback, removed all commitlint references as it has been removed from the project:
feat:,fix:,docs:format to plain descriptive messagesUpdated Documentation Structure
Before:
After:
Impact
Testing
Verified that:
Fixes #44
Original prompt
💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.