Skip to content

Add README, MIT license, and sponsor config - #84

Merged
StreamDemon merged 2 commits into
mainfrom
docs/github-repo-setup
Aug 5, 2026
Merged

Add README, MIT license, and sponsor config#84
StreamDemon merged 2 commits into
mainfrom
docs/github-repo-setup

Conversation

@StreamDemon

@StreamDemon StreamDemon commented Aug 5, 2026

Copy link
Copy Markdown
Owner

Summary

Sets up the public-facing GitHub repo surface to make the project legible (and attractive) to visitors and potential sponsors in the AI space:

  • README.md (new) — the AI-native pitch, spec-accurate code samples (actor counter, pipe-with-?, token-contract excerpt — all drawn from docs/examples/ and the prompt mirror, not hand-invented), the seven design principles, project status with the three bootstrap crates, the compiler roadmap from Compiler Roadmap #66 with milestone links, a docs map, contributing notes, and a sponsorship section.
  • LICENSE (new) — MIT. Cargo.toml has declared license = "MIT" since the bootstrap landed, but the license file itself was missing; this closes that gap.
  • .github/FUNDING.yml (new) — enables the GitHub Sponsors button (github: [StreamDemon]).
  • AGENTS.md (1 line) — the commit-message rule still instructed agents to sign with Co-Authored-By: Claude ... trailers, contradicting the maintainer's no-AI-footers policy (2026-07-02). Synced.

Repo topics and description are being set directly via repo settings (not files) in the same effort: programming-language, rust, compiler, wasm, ethereum, solana, llm, ai-agents.

Spec Sections Affected

None — no language-behavior changes. README quotes existing spec/examples content verbatim or in trimmed form; the spec version cited is v0.5.14-draft, matching current main.

Build Targets Tested

N/A (docs/metadata only; no compiler-crate changes).

Test plan

  • README code fences use the sploosh language tag and match docs/examples/hello-world.md, docs/examples/token-contract.md, and the §8 actor example shapes.
  • All README relative links point at files that exist in-tree; milestone/issue links point at the live GitHub milestones (1–8) and Compiler Roadmap #66.
  • Badge URLs reference the two real workflows (rust.yml, prompt-budget.yml).
  • CI: prompt-budget and Rust workflows unaffected (no docs/spec-plans/ or crates/ changes).

Summary by cubic

Adds a clear README, MIT license, and GitHub Sponsors config to improve the repo’s landing page and legitimacy. Also aligns commit-message rules in AGENTS.md with the maintainer policy.

  • New Features

    • Add README with pitch, spec-accurate samples, roadmap links, docs map, contributing, and sponsoring.
    • Add MIT LICENSE to match Cargo.toml.
    • Add .github/FUNDING.yml to enable the Sponsors button.
  • Bug Fixes

    • Sync AGENTS.md commit-message rules: no co-authored-by or generator footers anywhere.
    • Fix README keyword count to 45 (36 reserved + 9 contextual) to match the spec and lexer.

Written for commit a976105. Summary will update on new commits.

Review in cubic

The repo had no root README, no LICENSE despite Cargo.toml declaring
MIT, and no funding configuration. This makes the GitHub landing page
carry the project's actual pitch: the AI-native thesis, spec-accurate
code samples (drawn from docs/examples and the prompt mirror), the
compiler roadmap from issue #66 with milestone links, a docs map, and
a sponsorship section.

Also syncs the AGENTS.md commit-message rule with the maintainer's
no-AI-footers policy (2026-07-02), which the old wording contradicted
by instructing agents to add Co-Authored-By trailers.

@cubic-dev-ai cubic-dev-ai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

All reported issues were addressed across 4 files

Architecture diagram
sequenceDiagram
    participant C as Contributor
    participant GH as GitHub Repository
    participant D as README / Docs Hub
    participant A as AGENTS.md
    participant CI as CI Workflows
    participant SP as GitHub Sponsors

    Note over C,SP: Current-state public repo flow

    C->>GH: Open repository page
    GH->>D: Render README (badges, samples, roadmap)
    D-->>C: Show pitch, docs map, examples, MIT LICENSE
    C->>A: Read contribution conventions
    A-->>C: Enforce PR-only workflow, no AI footers
    C->>GH: Open PR / push branch
    GH->>CI: Trigger rust.yml and prompt-budget.yml
    CI->>D: Validate spec-example sync and prompt token budget
    CI-->>GH: Update workflow status badges
    C->>GH: Click Sponsors button
    GH->>SP: Resolve sponsor account from FUNDING.yml
    SP-->>C: Open GitHub Sponsors page
Loading

Reply with feedback, questions, or to request a fix.

Re-trigger cubic

Comment thread README.md Outdated
The README cited the v0.5.11-era count (44 = 36 + 8), which predates
`where` becoming a contextual keyword. Spec §2.3 and the lexer's
is_contextual_keyword both say 45 = 36 reserved + 9 contextual.
Flagged by cubic on PR #84.

@cubic-dev-ai cubic-dev-ai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

0 issues found across 1 file (changes from recent commits).

Confidence score: 5/5

  • Automated review surfaced no issues in the provided summaries.
  • No files require special attention.

Auto-approved: Repo-facing documentation and metadata only: README, standard MIT license matching Cargo.toml, FUNDING.yml, and an AGENTS.md rule sync. No code, API, or behavior changes requiring human judgment.

Re-trigger cubic

@StreamDemon
StreamDemon merged commit 8ecbd60 into main Aug 5, 2026
2 checks passed
@StreamDemon
StreamDemon deleted the docs/github-repo-setup branch August 5, 2026 00:57
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