docs: README logo/live-demo links, CONTRIBUTING.md, PR template - #331
Merged
Conversation
Closes most of the outstanding work in #6. Adds a logo header and live demo links to the client examples table in README.md, splits out a CONTRIBUTING.md covering the easy-to-miss frameworks.json registration step for new examples, adds a lightweight PR template adapted from the main handsontable repo's (dropping the CLA/changelog/wrapper checks that don't apply here), and a root AGENTS.md so AI agents follow the same PR template. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
6 tasks
Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
6 tasks
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
1 participant
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.
Context
Issue #6 asked for a README built off "our template" (logo + description), extended with contribution instructions, plus a repo description and a PR checklist. The README has already been substantially rewritten since the issue was filed and covers most of this; this PR closes the remaining gaps: a logo header, per-example live demo links, a CONTRIBUTING.md for the easy-to-miss frameworks.json registration step, a lightweight PR template, and a root AGENTS.md so AI agents follow the same template.
Types of changes
runner/) changeHow was this verified?
Verified the
?example=<folder-name>demo URL scheme againstrunner/apps/authoring/src/App.tsxandrunner/config/frameworks.jsonbefore adding a link per row (all 16 client-example slugs match their folder names exactly). Rendered the README locally to confirm the<picture>logo and the new table column don't break formatting. Grepped for the em dash character across all four touched/added files to confirm none remain.Checklist
runner/config/frameworks.json(see CONTRIBUTING.md); otherwise it won't appear on demos.handsontable.com. N/A, no new example in this PR.pnpm build(andpnpm dev) in the affected example/server-example locally. N/A, this PR only touches README.md, CONTRIBUTING.md, AGENTS.md, and .github/PULL_REQUEST_TEMPLATE.md.Related issue(s):
Note
Low Risk
Documentation and GitHub templates only; no runtime, CI, or example code changes.
Overview
Closes contributor-facing gaps from issue #6 by documenting how to add examples and standardizing PRs, plus a README refresh for discoverability.
README gets a centered logo/header with nav links, a Live demo column on the client-examples table (
demos.handsontable.com/?example=<slug>), a Contributing section pointing at the new guide, and minor copy/punctuation cleanup (no em dashes).New docs:
CONTRIBUTING.mdwalks through self-contained examples, CI discovery viabuild+pnpm-lock.yaml, README table rows, and the silent failure ifrunner/config/frameworks.jsonis not updated (plus Tier-2 container prep andimport.mjs)..github/PULL_REQUEST_TEMPLATE.mdadds checklists for change type, verification, andframeworks.json/README/build steps.AGENTS.md(andCLAUDE.mdalias) tells humans and agents to follow CONTRIBUTING and always fill the PR template.Reviewed by Cursor Bugbot for commit a838f3b. Bugbot is set up for automated code reviews on this repo. Configure here.