docs: add CONTRIBUTING and CODE_OF_CONDUCT - #64
Merged
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
Adds a standard repository governance/documentation set needed for a public release (license, security policy, contributing guide, and code of conduct), plus README links to those documents.
Changes:
- Add
LICENSE(MIT) for the repository. - Add
SECURITY.md,CONTRIBUTING.md, andCODE_OF_CONDUCT.mdwith project-specific guidance. - Append new “Contributing / Security / License” sections to
README.mdlinking to the new docs.
Reviewed changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| SECURITY.md | Introduces security reporting/scope guidance and security-relevant design notes. |
| README.md | Adds links to the new governance/security/license documents. |
| LICENSE | Adds MIT license text and copyright notice. |
| CONTRIBUTING.md | Documents local setup, tooling, workflow conventions, and verification commands. |
| CODE_OF_CONDUCT.md | Establishes community standards and reporting/enforcement process. |
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
This was referenced Sep 1, 2026
BunsDev
force-pushed
the
chore/governance-docs
branch
2 times, most recently
from
September 1, 2026 08:03
7c320e5 to
bfe9671
Compare
BunsDev
force-pushed
the
chore/governance-docs
branch
4 times, most recently
from
September 4, 2026 03:56
38486bc to
8527fe7
Compare
Add the two governance documents the repository still lacks before a public release. CONTRIBUTING.md is written against this repository rather than from a template: the real toolchain (Node 22+, pnpm 10.34.0 via Corepack, rust-toolchain.toml), the real script names, the worktree-per-branch convention, the signed-commit requirement including the pre-flight user.signingkey and gpg.format checks, and an honest description of the phase 1 conformance lock, including which paths it pins and the two-commit repin process. Contributors are told not to repin speculatively. CODE_OF_CONDUCT.md adapts the Contributor Covenant 2.1 principles and enforcement ladder, with attribution, and points reporting at the GitHub report control plus a private channel. LICENSE and SECURITY.md are deliberately not included here. They are carried by the release-infrastructure branch (#63); adding them in both places would guarantee a conflict. README.md is left untouched for the same reason: #63 already appends to it, and the links to these two files should be added once that lands. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Align the documented Node pin and Phase 1 authority scope with current main. Clarify conduct reporting channels and keep security reports on the SECURITY.md path.\n\nCo-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Correct the pinned setup, desktop connection model, branching and release guidance, signing checks, documentation validation, conformance repin process, and conduct reporting path. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
BunsDev
force-pushed
the
chore/governance-docs
branch
from
September 4, 2026 06:57
8527fe7 to
dc76504
Compare
Member
Author
|
Rebased once more onto current |
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.
Adds the two governance documents the repository still lacks before a public release. Documentation only — no source, build, workflow, or lock-pinned file is touched.
What this adds
CONTRIBUTING.mdCODE_OF_CONDUCT.mdBefore this change the repository had neither.
These are written against this repository, not dropped from a template
rust-toolchain.toml, Tauri prerequisites.typecheck,lint,test,build,cargo:fmt,cargo:clippy,cargo:test,test:e2e— each verified againstpackage.json.git worktree add -b <type>/<short-name> .worktrees/<short-name> origin/main.user.signingkey/gpg.formatchecks and thegit log -1 --show-signatureconfirmation, because a silently-failed signature is easy to miss until the commit is already pushed.phase1-conformance.lock.jsonpins the Rust host,scripts/,ci.yml, andclient-v1-conformance.yml; that touching any of them requires the two-commit repin includingdocs/phase1-conformance.mdandsrc/phase1-conformance-lock.test.ts; and that a contributor who is unsure should say so in the PR rather than repin speculatively. This is the single most likely way for a well-meaning outside contribution to break the build, and it was undocumented.CODE_OF_CONDUCT.mdadapts the Contributor Covenant 2.1 principles and enforcement ladder, with attribution, and routes reporting through GitHub's report control plus a private channel.Verification
git log -1 --show-signature→ good signature; commit shows as Verified.origin/mainat77ba6ae.src/,src-tauri/,scripts/,.github/, or*.lock.jsonpath is touched.pnpm lintis unaffected: Biome does not lint Markdown, and neither file is in thelintscript's path list.CI status
This PR is red, and not because of anything in it. A docs-only change reproduces the failure, which is how it was isolated:
Changed pathscorrectly classified it as docs-only and skipped E2E, Desktop build, Contract canary, and Phase 1 conformance.Web checksstill fails, inpnpm test:unit, atphase1-conformance-lock.test.tsandphase1-conformance.test.tswithError: Command failed: git merge-base.Resolved. The branch was cut from
77ba6ae, which still carried the old lock pinningb49cebc6, the pre-squash head of #57's branch. That commit stopped being reachable frommainthe moment #57 was squash-merged, sogit merge-basefailed on a fresh CI clone. #60 (4dc8f64) had already repinnedmainto a reachable revision; the branch simply predated it.Rebasing onto
4dc8f64fixes it, and this was confirmed rather than assumed: run 33485095922 is completed/success —Web checks=success,Contract canary=success, everything else correctly skipped for a docs-only diff.Follow-up
Once #63 lands,
README.mdshould gain links toLICENSE,SECURITY.md,CONTRIBUTING.md, andCODE_OF_CONDUCT.md. Left out of this PR deliberately so the two branches do not both edit the end of the README.