Skip to content

Conversation

@kevalyq
Copy link
Contributor

@kevalyq kevalyq commented Oct 26, 2025

πŸ“ Add Workflow Badges to README

This PR enhances the README by adding workflow badges for better visibility into the repository's health and status.

🎯 Changes

  • βœ… Added Quality Gates workflow badge (runs REUSE, license checks, linting, tests)
  • βœ… Added PR Size workflow badge (helps keep PRs manageable)
  • βœ… Updated license badge to match frontend style (shields.io with AGPL v3+ link)
  • ❌ Removed redundant REUSE badge (already checked in quality.yml)

πŸ“Š Before / After

Before:

[![REUSE Compliance](https://img.shields.io/badge/REUSE-compliant-green)](https://reuse.software/)
[![License: AGPL-3.0-or-later](https://img.shields.io/badge/License-AGPL%203.0+-blue.svg)](LICENSE)

After:

[![Quality Gates](https://github.com/SecPal/api/actions/workflows/quality.yml/badge.svg)](...)
[![PR Size](https://github.com/SecPal/api/actions/workflows/pr-size.yml/badge.svg)](...)
[![License: AGPL v3+](https://img.shields.io/badge/License-AGPL%20v3+-blue.svg)](...)

βœ… Alignment

Aligns with SecPal frontend and contracts repositories for consistent documentation.


Small documentation improvement! πŸ“š

- Added Quality Gates workflow badge
- Added PR Size workflow badge
- Updated license badge to match frontend style
- Removed redundant REUSE badge (checked in quality.yml)

Aligns with other SecPal repositories.
Copilot AI review requested due to automatic review settings October 26, 2025 22:59
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR enhances the README documentation by replacing the existing REUSE Compliance badge with workflow status badges and updating the license badge format. The changes improve visibility into the repository's CI/CD health while maintaining consistency with other SecPal repositories.

Key Changes:

  • Added Quality Gates and PR Size workflow badges to display CI/CD status
  • Updated license badge text and link to use AGPL v3+ format with external GNU license link
  • Removed REUSE Compliance badge (functionality covered by Quality Gates workflow)

@kevalyq kevalyq merged commit 487998a into main Oct 26, 2025
9 checks passed
@kevalyq kevalyq deleted the fix-readme-badges-docs branch October 26, 2025 23:05
kevalyq added a commit that referenced this pull request Nov 2, 2025
Removed option 3 from pre-push error message as it violates
Critical Rule #4: No Bypass policy.

The only legitimate override is .preflight-allow-large-pr for
exceptional cases with maintainer approval.

Follow-up to #81 based on Copilot review feedback.
kevalyq added a commit that referenced this pull request Nov 2, 2025
* fix: remove --no-verify suggestion from error message

Removed option 3 from pre-push error message as it violates
Critical Rule #4: No Bypass policy.

The only legitimate override is .preflight-allow-large-pr for
exceptional cases with maintainer approval.

Follow-up to #81 based on Copilot review feedback.

* refactor: optimize CHANGELOG validation for consistency

- Replace bash-specific [[ =~ ]] with POSIX-compliant case statement
- Combine multiple grep -v calls into single grep -Ev with pattern group
- Use grep -m 1 for early termination (performance improvement)
- Fix sed range calculation (UNRELEASED_END is relative, not absolute)
- Add clarifying comments about CHANGELOG_EXEMPT_PREFIXES and case sync
- Improve warning message with specific line count and non-blocking note
- Extract filter logic to reusable filter_changelog_content() function

Aligns api/scripts/preflight.sh with optimizations applied to frontend,
contracts, and .github repositories per Copilot review feedback.
kevalyq added a commit that referenced this pull request Nov 9, 2025
- Fix diff3 marker pattern: Change '||||||' to '||||||| ' (6β†’7 pipes + space)
- Update CHANGELOG: Correct conflict marker pattern to '||||||| '
- Update docs table: Fix diff3 marker pattern with trailing space
- Fix docs link: Change '../scripts/preflight.sh' to 'PREFLIGHT.md'

Resolves 4 Copilot review comments. Nitpick #4 (copyright format) is correct as-is.
kevalyq added a commit that referenced this pull request Nov 9, 2025
* feat: add Git conflict marker detection

- Add check-conflict-markers.sh script (95 lines)
- Integrate CI workflow for automated checks
- Document usage and troubleshooting
- Scans for <<<<<<, =======, >>>>>>>, ||||||| markers
- Prevents commits with unresolved merge conflicts
- Update CHANGELOG.md

* fix: resolve Copilot review comments in PR #124

- Fix diff3 marker pattern: Change '||||||' to '||||||| ' (6β†’7 pipes + space)
- Update CHANGELOG: Correct conflict marker pattern to '||||||| '
- Update docs table: Fix diff3 marker pattern with trailing space
- Fix docs link: Change '../scripts/preflight.sh' to 'PREFLIGHT.md'

Resolves 4 Copilot review comments. Nitpick #4 (copyright format) is correct as-is.

* docs: indent conflict marker examples in CHECK_CONFLICT_MARKERS.md

Prevents false positives in conflict marker detection script by
indenting the example markers in documentation.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants