Community-health files, issue/PR templates, and repo metadata#3
Merged
Conversation
Add the community-health and git-metadata set this fork was missing, so the repo reads as maintained and is easier to discover and contribute to: - CONTRIBUTING.md — the negative-control test rule, dev setup, DCO + credit conventions - CODE_OF_CONDUCT.md — Contributor Covenant v2.1 - SECURITY.md — honest emulator threat model + private vulnerability reporting - CHANGELOG.md — Keep a Changelog; first fork-namespaced release rp2350-v0.1.0 - CITATION.cff — citable metadata, lineage credited (Uri Shaked, c1570) - .github/ISSUE_TEMPLATE/ — ISA/instruction, peripheral/firmware, bug, and feature issue forms + config (blank issues off, upstream/Discussions contact links) - .github/PULL_REQUEST_TEMPLATE.md, CODEOWNERS, dependabot.yml (batched, monthly) - README.md — badge row (CI, tests, MIT, Node, TypeScript, PRs welcome) - package.json — homepage, bugs URL, expanded keywords, contributors (c1570, Pratheek) - .editorconfig — charset / EOL / final-newline / trailing-whitespace rules No source or emulator behavior changes. Signed-off-by: Pratheek Balakrishna <pratheekb96@gmail.com>
A cinematic social-preview image for GitHub link unfurls (X / Slack / Discord): the rendered PGA2350 carrier with its lit ghost matrix behind the rp2350js wordmark and the "emulated here, reflowed there" digital-twin line. Built from the plasma frame of docs/ghostshow-main.gif. Upload via repo Settings -> General -> Social preview (no API for this). Signed-off-by: Pratheek Balakrishna <pratheekb96@gmail.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
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.
What & why
This fork has the engineering substance — a corrected Hazard3 RISC-V core, 348 passing tests, and three firmware integration tests — but almost none of the community-health / git-metadata that signals maintained and lowers the barrier to contribute. This PR adds that layer. No source or emulator behavior changes.
Added
Community health
CONTRIBUTING.md— leads with the project's signature rule (every behavioral fix ships a negative-control test, proven red on the pre-fix engine), plus dev setup, code style, DCO sign-off, and credit/lineage conventions.CODE_OF_CONDUCT.md— Contributor Covenant v2.1.SECURITY.md— an honest emulator threat model (a dev-time digital twin, not a sandbox), what counts as a host-side vuln vs a normal emulation bug, and private vulnerability reporting.CHANGELOG.md— Keep a Changelog, with the first fork-namespaced releaserp2350-v0.1.0derived from the actual fix history.CITATION.cff— citable metadata, full MIT lineage credited (Uri Shaked, c1570).GitHub templates / automation
.github/ISSUE_TEMPLATE/— four issue forms tailored to this engine (RISC-V instruction/ISA incorrectness; peripheral/firmware boot; general bug; feature request) +config.ymlrouting RP2040-only reports upstream..github/PULL_REQUEST_TEMPLATE.md— a checklist matching the test/credit ethos..github/CODEOWNERS,.github/dependabot.yml(batched, monthly, low-noise).Discoverability / polish
README.mdbadge row (CI · tests · MIT · Node ≥18 · TypeScript · PRs welcome).package.json—homepage,bugs, expanded keywords, and acontributorsarray crediting c1570 and the maintainer..editorconfig— charset / EOL / final-newline / trailing-whitespace rules (additive to the existing file).Notes
rp2350-v0.1.0tag + GitHub Release marking the "boots the A2 bootrom, three firmware tests green, 348/348" milestone.