docs: update README badges - #69
Conversation
|
Welcome, @Arbaazyaseen15, and thanks for this! 🎉 Your badge additions in Two things to sort out before this can merge: 1. Base branch + stale starting point (the blocker)This PR targets Please retarget this PR to git remote add upstream https://github.com/alphacrack/iac-scanner.git # if needed
git fetch upstream
git rebase upstream/main
git push --force-with-lease
2. A few of your badges already exist on
|
Signed-off-by: Arbaaz Yaseen <arbaazyaseen@gmail.com>
ea34e50 to
801b44b
Compare
|
Hi @alphacrack, I've rebased the branch onto main, removed the duplicate badges that already existed, and kept only the new pypi/dm and pypi/implementation badges. |
alphacrack
left a comment
There was a problem hiding this comment.
Rebased — now adds only the two new badges (downloads, implementation), no duplicates. CI green. Thanks for iterating on the review feedback! 🎉
## Why Three first-time-contributor PRs open right now (#68, #69, #70) were all cut from a stale base and are unmergeable — because `CONTRIBUTING.md`, `CLAUDE.md`, and the PR template told them to branch from and target **`development`**, a branch frozen ~27 commits behind `main` since the v0.4.0 era. Everything actually ships from `main` (now protected). This PR fixes the misdirection. ## Changes - **CONTRIBUTING.md** — branch from / target `main`; add a one-time fork-sync snippet (`git remote add upstream … && git fetch upstream`) and a "if your PR shows dozens of files, rebase" troubleshooting note. - **PULL_REQUEST_TEMPLATE.md** — target `main`; the checklist now asks authors to confirm their branch is rebased on current `main` (diff shows only their files). - **CLAUDE.md** — state that `main` is the single trunk. ## Follow-up (separate, needs maintainer) Delete the `development` branch now that nothing points at it. Its 8 commits are old pre-squash v0.4.0 work already represented in `main`. ## Checklist - [x] Docs-only, no code/runtime change - [x] DCO signed - [x] Makes the review comments left on #68/#69/#70 accurate Fixes the root cause behind #68, #69, #70 base confusion. Signed-off-by: alphacrack <18480504+alphacrack@users.noreply.github.com>
Walkthrough - README Badge Updates
I have updated the badge section in the README to properly include all requested badges for the
iac-scanner==0.5.0release and verified that all badge image assets resolve correctly.Changes Made
README.md Updates
I updated the badge row at the top of README.md to include:
https://img.shields.io/pypi/dm/iac-scannerhttps://img.shields.io/pypi/implementation/iac-scannerandhttps://img.shields.io/pypi/pyversions/iac-scannerhttps://github.com/alphacrack/iac-scanner/actions/workflows/codeql.yml/badge.svghttps://api.securityscorecards.dev/projects/github.com/alphacrack/iac-scanner/badgehttps://img.shields.io/badge/DCO-required-blue.svgVerification & Testing
All URLs were verified to return an HTTP status of
200 OKand contain valid SVG image assets.Automated Test Output
We executed a custom test script to verify each badge URL:
https://img.shields.io/pypi/v/iac-scannerimage/svg+xmlhttps://img.shields.io/pypi/dm/iac-scannerimage/svg+xmlhttps://img.shields.io/pypi/pyversions/iac-scannerimage/svg+xmlhttps://img.shields.io/pypi/implementation/iac-scannerimage/svg+xmlhttps://github.com/alphacrack/iac-scanner/actions/workflows/ci.yml/badge.svgimage/svg+xmlhttps://github.com/alphacrack/iac-scanner/actions/workflows/codeql.yml/badge.svgimage/svg+xmlhttps://api.securityscorecards.dev/projects/github.com/alphacrack/iac-scanner/badgeimage/svg+xmlhttps://img.shields.io/badge/license-Apache%202.0-blue.svgimage/svg+xmlhttps://img.shields.io/badge/DCO-required-blue.svgimage/svg+xmlNote
The OpenSSF Scorecard badge was tested and returned a valid, live score of
4.5(openssf scorecard: 4.5). Since it is not broken and does not return a 404, I did not leave any warning or placeholder in the README, but it is fully active and validated.What & why
Fixes #
Behavior change
How to review
Test evidence
Checklist
development(notmain).git commit -s).ruff check src/ tests/andruff format --check src/ tests/clean.mypy src/iac_scannerclean (CI is--strict).pytest tests/ -m "not e2e").[Unreleased]updated for user-visible behavior.orchestration/tasks.py:PROMPT_VERSIONbumped.SCHEMA_VERSIONincache.pybumped.Roll-out notes