Skip to content

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.

Sign up for GitHub

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

Merged
04shubham7 merged 4 commits into from
Oct 19, 2025
Merged

docs: fix misleading CI and Label Checker badge status and remove commitlint references from README #45

Changes from 3 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
21a36ea
Initial plan
Copilot Oct 19, 2025
19b68e6
docs: fix badge URLs and clarify workflow documentation in README
Copilot Oct 19, 2025
ec254b6
docs: remove dynamic workflow badges that show confusing status
Copilot Oct 19, 2025
0677b3a
docs: remove commitlint references from README per maintainer request
Copilot Oct 19, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 7 additions & 9 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,6 @@
![License: MIT](https://img.shields.io/badge/license-MIT-blue)
![Contributions Welcome](https://img.shields.io/badge/contributions-welcome-brightgreen)
![Build Passing](https://img.shields.io/badge/build-passing-green)
![CI](https://github.com/OPCODE-Open-Spring-Fest/UniLoot/workflows/CI/badge.svg)
![Label Checker](https://github.com/OPCODE-Open-Spring-Fest/UniLoot/workflows/Label%20Checker/badge.svg)

</div>

Expand Down Expand Up @@ -156,16 +154,16 @@ git commit -m "fix: resolve payment gateway issue"
git commit -m "docs: update README with setup instructions"
```

### CI/CD Workflows
### Commit Message Validation

This project has automated CI/CD workflows that run on every push and pull request:

#### 🔍 Commitlint (CI Workflow)
#### 🔍 Commitlint (Local Git Hooks)
Copy link
Member

@04shubham7 04shubham7 Oct 19, 2025

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

Copy link
Contributor Author

Copilot AI Oct 19, 2025

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)

- **Validates** all commit messages follow the [Conventional Commits](https://www.conventionalcommits.org/) format
- **Runs on**: Every push and pull request
- **Runs on**: Every commit (via Husky git hooks)
- **Required format**: `type(scope): description`
- **Common types**: `feat`, `fix`, `docs`, `style`, `refactor`, `test`, `chore`

### GitHub Actions Workflows

#### 🏷️ Label Checker
- **Validates** that pull requests have required labels before merging
- **Required labels** (one from each group):
Expand All @@ -174,7 +172,7 @@ This project has automated CI/CD workflows that run on every push and pull reque
- **Status**: `PR:Accept`
- **Runs on**: Pull request opened, edited, synchronized, reopened, labeled, or unlabeled events

All CI checks must pass before a pull request can be merged.
All checks must pass before a pull request can be merged.

---

Expand All @@ -196,7 +194,7 @@ Make sure to:
- Follow the [Code of Conduct](CODE_OF_CONDUCT.md)
- Write clear commit messages following the conventional commits format
- Add appropriate labels to your PR (Type, Semver, and PR:Accept)
- Ensure all CI checks pass
- Ensure all GitHub Actions checks pass
- Update documentation as needed

---
Expand Down
Loading