Skip to content

P0–P2 polish: PolyForm Noncommercial license, screenshots, RU mirror, CI#1

Merged
CreatmanCEO merged 2 commits into
masterfrom
polish-readme-and-meta
May 3, 2026
Merged

P0–P2 polish: PolyForm Noncommercial license, screenshots, RU mirror, CI#1
CreatmanCEO merged 2 commits into
masterfrom
polish-readme-and-meta

Conversation

@CreatmanCEO
Copy link
Copy Markdown
Owner

Summary

Single PR addressing three things at once:

  1. License switch from MIT → PolyForm Noncommercial 1.0.0 to match the project's actual intent (built for friends and family, not for commercial use)
  2. README repositioning — from "portfolio piece" framing into "open-source non-commercial tool, contributors welcome under the same terms"
  3. Standard sister-repo polish — badges, screenshots, architecture diagram, RU mirror, CI

The README was already strong (April 3 portfolio rewrite). This PR adds what was missing: official non-commercial license, real screenshots from tests/manual screenshots/, an explicit "needs help with" Roadmap, dynamic CI in place of the static Tests: 72 badge, and cross-links to the sister Claude Code repos.

What changed

P0 — credibility & accuracy + new positioning

  • LICENSE: official PolyForm Noncommercial 1.0.0 (canonical text from spdx mirror), replacing MIT
  • Hero blurb repositioned: "built for friends and family by a sibling-of-T1D developer, shared with the community. Active development — contributors welcome under non-commercial terms"
  • Status — non-commercial use only callout under hero linking to the license + the Roadmap
  • 6 hero badges: License, Stars, Validate CI, Status, Python 3.11+, Telegram Bot API
  • Topics + description — applied via gh api after merge

P1 — structural strengthening

  • docs/architecture.svg — pipeline diagram (Telegram → handlers → litellm Router with two chains → user confirmation gate → nutrition + database → daily progress, with Google Search grounding sidecar)
  • 5-screenshot 2-column gallery:
    • 01 — KBJU result (hero, 37 KB) — final per-item table + daily progress
    • 02 — Photo recognition (260 KB; the size is the embedded photo) — meal photo + recognition card + Confirm/Cancel buttons
    • 03 — Daily report (33 KB) — /today output with progress bars
    • 04 — Onboarding setup (18 KB)
    • 05 — Onboard confirm (12 KB)
  • Caption: "UI shown in Russian (default locale). English locale also fully supported — language follows the user's Telegram preference."
  • New Roadmap & known limitations section with:
    • Safety disclaimer: "this is an assistance tool, not a medical device. Always cross-check carb counts before insulin dosing. The two-step recognise → confirm flow is safety-critical, not cosmetic."
    • Active improvements (contributors welcome): tighter LLM prompting + schema validation, more precise dietetic calculations (verified portions / GL / fibre), user-facing answer verification (confidence scores + double-check flag), external KBJU databases (USDA / OpenFoodFacts / regional), regional adaptation (EU/US/RU/Asia)
    • Current limits: LLM misidentification edge cases, no CGM integration yet, EN-locale verification ongoing, grounding only on Gemini chain, metric units only
  • CHANGELOG.md in Keep a Changelog format reconstructing earlier history from git log (0.1.0 initial → 0.2.0 April 3 portfolio rewrite + 8 live fixes → 0.3.0 this PR)
  • CONTRIBUTING.md with explicit non-commercial clause and the same priority list as the Roadmap
  • .github/workflows/validate.yml — runs the full 72-test pytest suite on push/PR with dummy env vars for API keys, plus py_compile, SVG XML, asset existence, internal Markdown link resolution
  • Static Tests: 72 badge replaced with dynamic Validate CI badge
  • "Related" section cross-linking to all 4 sister Claude Code repos: anti-regression-setup, ai-context-hierarchy, claude-statusline, lingua-companion

P2 — content

  • README.ru.md — full Russian mirror with the same badges, gallery, architecture, Roadmap, license callout
  • Split from previous inline bilingual format for sister-repo consistency and easier translation maintenance
  • Author signature expanded with Habr / dev.to profile links

What is NOT in this PR

  • Default branch rename master → main — invasive, would invalidate any external bookmarks pointing at master. Deferred to a separate one-line change.
  • awesome-claude-code submission — channel still locked for non-collaborators.
  • Code refactors — pure docs/meta PR. No business logic touched.

Test plan

  • LICENSE and CHANGELOG.md exist
  • python -m py_compile clean on every *.py
  • docs/architecture.svg is well-formed XML
  • All 5 referenced screenshots exist on disk
  • All internal Markdown links from README / README.ru.md / CHANGELOG / CONTRIBUTING resolve
  • CI will run the full 72-test pytest suite (results visible in the Validate check)

🤖 Generated with Claude Code

CreatmanCEO and others added 2 commits May 3, 2026 08:43
P0 — credibility & accuracy + new positioning
- LICENSE changed from MIT to PolyForm Noncommercial 1.0.0 (canonical text from spdx)
- README repositioned: open-source non-commercial, built for friends and
  family, contributors welcome under non-commercial terms
- Hero "Status — non-commercial use only" callout linking to license + roadmap
- 6 hero badges: License, Stars, Validate CI, Status, Python 3.11+, Telegram

P1 — structural strengthening
- docs/architecture.svg — pipeline diagram (Telegram → handlers →
  litellm Router with two chains → user confirmation gate → nutrition
  + database → daily progress, with Google Search grounding sidecar)
- 5 screenshots in 2-column gallery:
  01 — KBJU result (hero, 37 KB) — final per-item table + daily progress
  02 — Photo recognition (260 KB) — meal photo + recognition card + buttons
  03 — Daily report (33 KB) — /today output with progress bars
  04 — Onboarding setup (18 KB) — profile inputs + auto-targets
  05 — Onboard confirm (12 KB) — final review before IDLE
- Caption clarifies UI is in RU (default locale), EN locale also fully supported
- New "Roadmap & known limitations" section with safety disclaimer
  (this is an assistance tool, not a medical device — always cross-check
  carb counts before insulin dosing) and explicit list of active
  improvements where contributors are needed:
  * tighter LLM prompting + JSON-schema validation
  * more precise dietetic calculations (verified portions, GL, fibre)
  * user-facing answer verification (confidence scores, "double-check"
    flag at low confidence)
  * external KBJU databases (USDA, OpenFoodFacts, regional sources)
  * regional adaptation (EU/US/RU/Asia food norms, cuisines, brands)
- Current limits documented: LLM misidentification edge cases, no CGM
  integration yet, EN-locale verification ongoing, grounding only on
  Gemini chain, metric units only
- CHANGELOG.md (Keep a Changelog) reconstructing earlier history from
  git log: 0.1.0 (initial) → 0.2.0 (Apr 3 portfolio rewrite + 8 live
  fixes including PicklePersistence, entry_points, allow_reentry,
  correction prompt fallback, unexpected LLM fields, post_init injection)
  → 0.3.0 (this PR — license change + docs polish)
- CONTRIBUTING.md with explicit non-commercial clause and concrete
  priority list mirroring the Roadmap section
- .github/workflows/validate.yml — runs the full 72-test pytest suite
  on push and PR (with dummy env vars for API keys), plus py_compile,
  SVG XML, asset existence, internal Markdown link resolution
- Static "Tests: 72" badge replaced with the dynamic Validate CI badge
- Stars badge added
- "Related" section cross-linking to all 4 sister Claude Code repos

P2 — content
- README.ru.md — full Russian mirror with the same badges, gallery,
  architecture, Roadmap, license callout (split from previous inline
  bilingual format for sister-repo consistency and easier translation
  maintenance)
- Author signature expanded with Habr / dev.to profile links

Excluded (per author instruction)
- Default branch rename (master → main) — invasive, deferred
- awesome-claude-code submission — channel still locked

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
@CreatmanCEO CreatmanCEO merged commit 7618815 into master May 3, 2026
1 check passed
@CreatmanCEO CreatmanCEO deleted the polish-readme-and-meta branch May 3, 2026 12:56
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.

1 participant