-
Notifications
You must be signed in to change notification settings - Fork 0
docs: add workflow badges to README #4
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
- 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.
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.
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)
* 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.
- 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.
* 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.
π 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
π Before / After
Before:
After:
β Alignment
Aligns with SecPal frontend and contracts repositories for consistent documentation.
Small documentation improvement! π