Add README, MIT license, and sponsor config - #84
Merged
Conversation
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.
There was a problem hiding this comment.
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
Reply with feedback, questions, or to request a fix.
Re-trigger cubic
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.
There was a problem hiding this comment.
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
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
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 fromdocs/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.tomlhas declaredlicense = "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 withCo-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
splooshlanguage tag and matchdocs/examples/hello-world.md,docs/examples/token-contract.md, and the §8 actor example shapes.rust.yml,prompt-budget.yml).docs/spec-plans/orcrates/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
LICENSEto matchCargo.toml..github/FUNDING.ymlto enable the Sponsors button.Bug Fixes
AGENTS.mdcommit-message rules: no co-authored-by or generator footers anywhere.Written for commit a976105. Summary will update on new commits.