Skip to content

Repo Upgrade Pack: README, community health files, CI, pilot-kit - #1

Merged
porroto merged 8 commits into
mainfrom
claude/map-completion-hovibn
Jul 8, 2026
Merged

Repo Upgrade Pack: README, community health files, CI, pilot-kit#1
porroto merged 8 commits into
mainfrom
claude/map-completion-hovibn

Conversation

@porroto

@porroto porroto commented Jul 8, 2026

Copy link
Copy Markdown
Owner

What does this change?

Implements the Phase 1-3 items from the Agentic-Education Upgrade Pack that can be done through repo files (the rest — About sidebar, social preview upload, pinning, Discussions, Zenodo DOI — need manual GitHub Settings/account actions and are called out below).

  • fix: remove duplicate LICENSE.md (kept LICENSE, MIT) — clears GitHub's "MIT, Unknown licenses found" flag
  • docs: rewrite README.md — badges, Mermaid architecture diagram, safety boundary, audience guide, roadmap snapshot
  • docs: add CONTRIBUTING.md, CODE_OF_CONDUCT.md, SECURITY.md, .github/PULL_REQUEST_TEMPLATE.md
  • docs: add folder-level READMEs to all 10 top-level content folders (agents/, framework/, governance/, papers/, prototypes/, badges/, missions/, proposals/, docs/, gh600/)
  • docs: fix CITATION.cff — correct repo URL, resolve license field, add preferred-citation for the concept paper plus version/date
  • ci: add .github/workflows/ci.yml — compiles all Python prototypes and validates the example badge JSON against badge-metadata-schema.json
  • docs: add pilot-kit/ — assembles the consent template, a new teacher walkthrough of the learning loop, and a mock-wallet slide outline (the research-to-classroom bridge)
  • chore: add assets/social-preview.png — a 1280x640 banner rendered from HTML via headless Chromium, ready to upload to Settings

Why?

Requested repo polish/credibility pass ("Agentic-Education Upgrade Pack") to fix the license conflict, make the repo self-explanatory folder-by-folder, add standard community health files, and add a first classroom-facing pilot kit.

Checklist

  • Contains no real student data — synthetic or de-identified examples only
  • Follows the trust-first safety boundary (human validation stays final, no financial/token speculation)
  • Markdown/JSON changes pass the repo's automated checks (badge JSON validated locally against the schema; Python prototypes compile)
  • Folder-level README updated for every folder touched
  • ROADMAP.md updated — left as-is; pilot-kit/ is a first draft skeleton, not a completed/run pilot, so the roadmap item stays unchecked intentionally

Still needs manual action (not doable via repo files/API)

  • About sidebar: description + topics
  • Upload assets/social-preview.png at Settings → General → Social preview
  • Pin the repo on your profile
  • Enable GitHub Discussions
  • Tag/publish the v0.1.0 release (a local v0.1.0 tag was created but couldn't be pushed — this session's push credentials are scoped to this branch only)
  • Zenodo DOI for the concept paper

Test plan

  • python -m py_compile on every .py file in the repo
  • Validated both example badge JSON files against badge-metadata-schema.json with jsonschema locally — both pass
  • Rendered and visually checked the social preview banner at 1280x640

Generated by Claude Code

claude added 8 commits July 8, 2026 22:21
LICENSE.md was a pending-selection placeholder that conflicted with the
real MIT LICENSE, causing GitHub's 'multiple licenses' warning.

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_017mpX1bitYfFC5vMfNEgb53
Replaces the minimal README with a fuller draft: shields.io badges, a
Mermaid diagram of the three-layer architecture, an explicit safety
boundary section, audience guide, and roadmap snapshot.

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_017mpX1bitYfFC5vMfNEgb53
Adds the community health files GitHub surfaces automatically, all
anchored to this project's non-negotiable rule: synthetic/de-identified
data only, human validation stays final.

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_017mpX1bitYfFC5vMfNEgb53
One paragraph per folder covering what lives there, its state
(draft/stable/experimental), and how it connects to the concept paper,
turning the folder tree into a guided tour.

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_017mpX1bitYfFC5vMfNEgb53
Fix repository-code URL casing, resolve the license field now that
LICENSE.md is gone, and add a preferred-citation for the concept paper
plus version/date so GitHub's Cite button has something meaningful.

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_017mpX1bitYfFC5vMfNEgb53
Compiles every Python prototype and validates the example badge JSON
files against badge-metadata-schema.json on every push/PR, so a green
check quietly signals engineering discipline.

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_017mpX1bitYfFC5vMfNEgb53
Assembles existing consent, teacher-validation, and rubric documents
into one classroom-facing kit, and adds a teacher walkthrough of the
learning loop plus a mock-wallet slide outline for introducing badges
to students and families before any real badge is issued.

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_017mpX1bitYfFC5vMfNEgb53
1280x640 PNG rendered from an HTML source via headless Chromium,
matching the README's mission/tagline/three-layer messaging. Upload to
Settings > General > Social preview manually — GitHub doesn't expose
that setting through the API.

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_017mpX1bitYfFC5vMfNEgb53
@porroto
porroto merged commit db78e58 into main Jul 8, 2026
4 checks passed
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.

2 participants