|
| 1 | +# 📋 Badge Tasks & Reminders |
| 2 | + |
| 3 | +**Created:** November 12, 2025 |
| 4 | +**Target Completion:** November 13-14, 2025 |
| 5 | +**Status:** ⏳ Waiting for badge services to index package |
| 6 | + |
| 7 | +--- |
| 8 | + |
| 9 | +## 🎯 Primary Task: Restore Dynamic Badges |
| 10 | + |
| 11 | +**Due Date:** November 13-14, 2025 (48 hours after PyPI publish) |
| 12 | + |
| 13 | +### Task Checklist: |
| 14 | + |
| 15 | +- [ ] **Day 1 (Nov 13)** - Test if badges are indexed |
| 16 | + - [ ] Test PyPI version badge: https://img.shields.io/pypi/v/empathy-framework.svg |
| 17 | + - [ ] Test Python versions badge: https://img.shields.io/pypi/pyversions/empathy-framework.svg |
| 18 | + - [ ] Test downloads badge: https://img.shields.io/pypi/dm/empathy-framework.svg |
| 19 | + - [ ] If all return valid images (not errors), proceed to restore |
| 20 | + |
| 21 | +- [ ] **Restore Badges in README.md** |
| 22 | + - [ ] Replace simplified badges with full dynamic badges |
| 23 | + - [ ] Test all badge URLs in browser |
| 24 | + - [ ] Verify they display correctly on GitHub |
| 25 | + - [ ] Commit and push changes |
| 26 | + |
| 27 | +- [ ] **Verify on GitHub** |
| 28 | + - [ ] Check README displays correctly |
| 29 | + - [ ] All badges show proper status |
| 30 | + - [ ] No broken images |
| 31 | + |
| 32 | +- [ ] **Clean Up** |
| 33 | + - [ ] Delete BADGES_REMINDER.md |
| 34 | + - [ ] Delete this TODO_BADGES.md file |
| 35 | + - [ ] Commit cleanup |
| 36 | + |
| 37 | +--- |
| 38 | + |
| 39 | +## 🔧 Optional Enhancement Tasks |
| 40 | + |
| 41 | +**Priority:** Medium |
| 42 | +**Timeline:** Week 2-3 |
| 43 | + |
| 44 | +### CodeCov Setup |
| 45 | +- [ ] Set up CodeCov account |
| 46 | +- [ ] Add CODECOV_TOKEN to GitHub secrets |
| 47 | +- [ ] Update GitHub Actions to upload coverage |
| 48 | +- [ ] Add codecov badge to README |
| 49 | +- [ ] Verify badge works |
| 50 | + |
| 51 | +**Files to modify:** |
| 52 | +- `.github/workflows/tests.yml` - Add codecov upload step |
| 53 | + |
| 54 | +**Resources:** |
| 55 | +- CodeCov docs: https://docs.codecov.com/docs/quick-start |
| 56 | +- GitHub Action: https://github.com/codecov/codecov-action |
| 57 | + |
| 58 | +### OpenSSF Scorecard Setup |
| 59 | +- [ ] Visit https://securityscorecards.dev |
| 60 | +- [ ] Register empathy-framework repository |
| 61 | +- [ ] Review security recommendations |
| 62 | +- [ ] Fix any security issues |
| 63 | +- [ ] Add OpenSSF badge to README |
| 64 | +- [ ] Verify badge works |
| 65 | + |
| 66 | +**Resources:** |
| 67 | +- OpenSSF docs: https://github.com/ossf/scorecard |
| 68 | +- Badge info: https://securityscorecards.dev/ |
| 69 | + |
| 70 | +### GitHub Actions Status Badge |
| 71 | +- [ ] Ensure tests.yml workflow exists |
| 72 | +- [ ] Verify workflow runs successfully |
| 73 | +- [ ] Add Tests badge to README |
| 74 | +- [ ] Test badge displays correctly |
| 75 | + |
| 76 | +**Badge URL:** |
| 77 | +```markdown |
| 78 | +[](https://github.com/Smart-AI-Memory/empathy-framework/actions/workflows/tests.yml) |
| 79 | +``` |
| 80 | + |
| 81 | +--- |
| 82 | + |
| 83 | +## 📊 Additional Badge Ideas |
| 84 | + |
| 85 | +**Priority:** Low |
| 86 | +**Timeline:** As needed |
| 87 | + |
| 88 | +### Quality Badges |
| 89 | +- [ ] Code Climate maintainability |
| 90 | +- [ ] Snyk security scan |
| 91 | +- [ ] Better Code Hub |
| 92 | +- [ ] Codacy code quality |
| 93 | + |
| 94 | +### Community Badges |
| 95 | +- [ ] Discord server (if created) |
| 96 | +- [ ] Gitter chat |
| 97 | +- [ ] GitHub Discussions |
| 98 | + |
| 99 | +### Stats Badges |
| 100 | +- [ ] Total downloads |
| 101 | +- [ ] Contributors count |
| 102 | +- [ ] Last commit date |
| 103 | +- [ ] Repo size |
| 104 | + |
| 105 | +### Documentation Badges |
| 106 | +- [ ] Read the Docs |
| 107 | +- [ ] Documentation coverage |
| 108 | +- [ ] API docs status |
| 109 | + |
| 110 | +--- |
| 111 | + |
| 112 | +## 🚨 Troubleshooting Guide |
| 113 | + |
| 114 | +### If Badges Still Show Errors After 48 Hours: |
| 115 | + |
| 116 | +**PyPI Badges:** |
| 117 | +1. Clear shields.io cache: Add `?v=1` to URL |
| 118 | +2. Try alternative badge services (badgen.net) |
| 119 | +3. Check if package name is correct (empathy-framework) |
| 120 | +4. Verify package is publicly visible on PyPI |
| 121 | + |
| 122 | +**GitHub Action Badges:** |
| 123 | +1. Check workflow file exists in `.github/workflows/` |
| 124 | +2. Verify workflow has run at least once |
| 125 | +3. Check workflow name matches badge URL |
| 126 | +4. Ensure repository is public |
| 127 | + |
| 128 | +**CodeCov Badge:** |
| 129 | +1. Verify coverage report is being uploaded |
| 130 | +2. Check CodeCov token is set in secrets |
| 131 | +3. Ensure repository is linked to CodeCov account |
| 132 | +4. Try forcing a sync on CodeCov dashboard |
| 133 | + |
| 134 | +**OpenSSF Badge:** |
| 135 | +1. Verify repository is registered |
| 136 | +2. Check if first scan has completed |
| 137 | +3. May take 24-48 hours for initial scan |
| 138 | +4. Check badge URL format is correct |
| 139 | + |
| 140 | +--- |
| 141 | + |
| 142 | +## 📝 Badge Restore Template |
| 143 | + |
| 144 | +**When ready to restore, replace README badges section with:** |
| 145 | + |
| 146 | +```markdown |
| 147 | +[](LICENSE) |
| 148 | +[](https://pypi.org/project/empathy-framework/) |
| 149 | +[](https://www.python.org/downloads/) |
| 150 | +[](https://pypi.org/project/empathy-framework/) |
| 151 | +[](https://github.com/Smart-AI-Memory/empathy-framework/actions/workflows/tests.yml) |
| 152 | +[](https://codecov.io/gh/Smart-AI-Memory/empathy-framework) |
| 153 | +[](https://securityscorecards.dev/viewer/?uri=github.com/Smart-AI-Memory/empathy-framework) |
| 154 | +[](https://github.com/psf/black) |
| 155 | +[](https://github.com/astral-sh/ruff) |
| 156 | +``` |
| 157 | + |
| 158 | +--- |
| 159 | + |
| 160 | +## ✅ Quick Test Commands |
| 161 | + |
| 162 | +**Test badge URLs (run on Nov 13-14):** |
| 163 | + |
| 164 | +```bash |
| 165 | +# Test if badges return HTTP 200 (success) |
| 166 | +curl -I https://img.shields.io/pypi/v/empathy-framework.svg |
| 167 | +curl -I https://img.shields.io/pypi/pyversions/empathy-framework.svg |
| 168 | +curl -I https://img.shields.io/pypi/dm/empathy-framework.svg |
| 169 | + |
| 170 | +# If you see "HTTP/2 200" → badges are ready! |
| 171 | +# If you see "HTTP/2 404" or errors → wait longer |
| 172 | +``` |
| 173 | + |
| 174 | +**Check PyPI package visibility:** |
| 175 | + |
| 176 | +```bash |
| 177 | +# Should return JSON with package info |
| 178 | +curl https://pypi.org/pypi/empathy-framework/json | jq '.info.version' |
| 179 | + |
| 180 | +# Should show: "1.6.1" |
| 181 | +``` |
| 182 | + |
| 183 | +--- |
| 184 | + |
| 185 | +## 📅 Timeline Summary |
| 186 | + |
| 187 | +| Date | Task | Status | |
| 188 | +|------|------|--------| |
| 189 | +| Nov 12 | Package published to PyPI | ✅ Done | |
| 190 | +| Nov 12 | Simplified badges committed | ✅ Done | |
| 191 | +| Nov 12 | Created badge reminders | ✅ Done | |
| 192 | +| **Nov 13** | **Test badge URLs** | ⏳ Pending | |
| 193 | +| **Nov 13-14** | **Restore dynamic badges** | ⏳ Pending | |
| 194 | +| Nov 14 | Verify badges on GitHub | ⏳ Pending | |
| 195 | +| Nov 14 | Clean up reminder files | ⏳ Pending | |
| 196 | +| Week 2+ | Optional enhancements | 📋 Backlog | |
| 197 | + |
| 198 | +--- |
| 199 | + |
| 200 | +## 🔗 Quick Links |
| 201 | + |
| 202 | +- **Package:** https://pypi.org/project/empathy-framework/ |
| 203 | +- **Repository:** https://github.com/Smart-AI-Memory/empathy-framework |
| 204 | +- **README:** https://github.com/Smart-AI-Memory/empathy-framework/blob/main/README.md |
| 205 | +- **Shields.io:** https://shields.io |
| 206 | +- **Badge Guide:** https://github.com/badges/shields |
| 207 | + |
| 208 | +--- |
| 209 | + |
| 210 | +**Last Updated:** November 12, 2025 |
| 211 | +**Next Review:** November 13, 2025 |
| 212 | +**Owner:** Patrick Roebuck |
0 commit comments