P0–P2 polish: PolyForm Noncommercial license, screenshots, RU mirror, CI#1
Merged
Conversation
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>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Single PR addressing three things at once:
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 staticTests: 72badge, 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 MITStatus — non-commercial use onlycallout under hero linking to the license + the Roadmapgh apiafter mergeP1 — 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)/todayoutput with progress barsRoadmap & known limitationssection with:CHANGELOG.mdin Keep a Changelog format reconstructing earlier history fromgit log(0.1.0 initial → 0.2.0 April 3 portfolio rewrite + 8 live fixes → 0.3.0 this PR)CONTRIBUTING.mdwith 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, pluspy_compile, SVG XML, asset existence, internal Markdown link resolutionTests: 72badge replaced with dynamic Validate CI badgeP2 — content
README.ru.md— full Russian mirror with the same badges, gallery, architecture, Roadmap, license calloutWhat is NOT in this PR
master → main— invasive, would invalidate any external bookmarks pointing atmaster. Deferred to a separate one-line change.Test plan
LICENSEandCHANGELOG.mdexistpython -m py_compileclean on every*.pydocs/architecture.svgis well-formed XML🤖 Generated with Claude Code