Skip to content

docs(launch): repo-owner onboarding checklist (#254) - #933

Merged
JSONbored merged 1 commit into
JSONbored:mainfrom
oktofeesh1:docs/issue-254-owner-checklist
Jun 20, 2026
Merged

docs(launch): repo-owner onboarding checklist (#254)#933
JSONbored merged 1 commit into
JSONbored:mainfrom
oktofeesh1:docs/issue-254-owner-checklist

Conversation

@oktofeesh1

Copy link
Copy Markdown
Contributor

Fixes #254. Re-opens #932 (closed by the one-shot review gate) with the public-safety note addressed.

Adds /docs/owner-checklist — a pre-flight checklist a repo owner works through before inviting Gittensory contribution traffic. It mirrors the real registration-readiness report dimensions, so every item maps to something the platform actually checks, each with the honest tradeoff being opted into.

What changed since #932

A reviewer flagged forbidden public-boundary terms in the prose. This revision removes every canonical forbidden term from the visible text:

  • section 3 / section 7 Callouts: rewardsincentivizes / credits;
  • section 8: dropped the explicit wallet/hotkey/payout/trust-score/ranking/farming enumeration — it now says economic and identity signals are stripped without naming the trigger words.

The doc now passes the canonical sanitizer (isPublicSafeText) end-to-end, and the test asserts that (expect(isPublicSafeText(source)).toBe(true)) — the guard #254's acceptance criteria asked for, which also prevents regressions.

Checklist sections (each grounded in real code)

Registration · repo policy & config quality (.gittensory.yml, settings-preview) · labels & trusted pipeline · issue quality · contribution lanes (ParticipationLane: direct_pr/issue_discovery/split/inactive/unknown, via gittensor-config-recommendation) · validation & gate readiness (testCoverageHealth) · maintainer capacity & queue health (queueHealth, maintainerCutReadiness) · public/private boundaries (publicSurface/commentMode/publicAudienceMode).

Acceptance criteria

  • Covers repo policy, labels, issue quality, validation commands, maintainer capacity, contribution lanes, public/private boundaries.
  • Honest tradeoffs around maintainer burden and low-quality PR pressure.
  • Links to the owner workflow (beta onboarding) and privacy/onboarding surfaces.
  • Public-output safety: doc contains no forbidden terms; test enforces isPublicSafeText.

Notes

  • Pure docs (apps/** excluded from coverage). Endpoints, the repo-owner-intake profile, and the lane taxonomy verified against src/api/routes.ts, packages/gittensory-mcp/bin/gittensory-mcp.js, and src/signals/{registration-readiness,engine,redaction}.ts.
  • routeTree.gen.ts regenerated by the TanStack router plugin.

🤖 Generated with Claude Code

Adds /docs/owner-checklist, a pre-flight checklist a repo owner works through
before inviting Gittensory contribution traffic. It mirrors the real
registration-readiness report dimensions, so every item maps to something the
platform actually checks, and each carries the honest tradeoff being opted into:

- Repository registration, config quality (.gittensory.yml), labels & trusted
  pipeline, issue quality, contribution lanes, validation/gate readiness,
  maintainer capacity & queue health, and the public/private boundary.
- Cites the real owner endpoints (GET registration-readiness,
  GET gittensor-config-recommendation, POST settings-preview) and the
  repo-owner-intake review-only agent profile.
- Honest tradeoffs around maintainer burden and low-quality PR pressure
  (split lane triage cost, maintainer cut vs miner share, linked-issue friction,
  turning on public surfaces).
- Lane taxonomy matches ParticipationLane (direct_pr / issue_discovery / split /
  inactive / unknown); public/private section names what the sanitizer scrubs.

Linked from the docs index (Repo owners). test/unit/docs-owner-checklist.test.ts
mirrors the miner-quickstart doc test: asserts every required checklist
dimension, the real endpoints/profile, the lane taxonomy, the honest tradeoffs,
the owner-workflow links, and the absence of reward/score-prediction/secret copy.

Fixes JSONbored#254

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
@oktofeesh1
oktofeesh1 requested a review from JSONbored as a code owner June 20, 2026 11:39
@dosubot dosubot Bot added the size:L label Jun 20, 2026
@ghost ghost added the gittensor:priority Maintainer-selected Gittensor priority — scores a 1.5x multiplier. label Jun 20, 2026
@ghost

ghost commented Jun 20, 2026

Copy link
Copy Markdown

Note

Gittensory Gate skipped

PR closed before full evaluation. No late first comment was created.

Signal Result Evidence Action
Gate result ⚠️ Skipped #933 is no longer open. No action.

💰 Earn for open-source contributions like this. Gittensor lets GitHub contributors earn for the work they already do — register to start earning →.

Checked by Gittensory, a quiet PR intelligence layer for OSS maintainers.

@ghost ghost added the gittensory:reviewed label Jun 20, 2026
@ghost

ghost commented Jun 20, 2026

Copy link
Copy Markdown

🔍 Maintainer review

Reviewed 4 file(s) — ✅ all CI green.

Suggested action:Safe to merge — both reviewers found no blocking issues.

Reviewer A · gpt-oss-120b — recommends ✅ merge
The PR adds a new public documentation page with an onboarding checklist, integrates it into the route tree, updates the docs index navigation, and includes comprehensive tests. The page contains no forbidden terms and passes the public‑safety sanitizer check. UI routing changes appear correct and type‑safe. No backend or security‑critical logic is altered.

Suggestions

  • Verify that the new route is included in any sitemap or static generation config if applicable.
  • Run the full UI test suite to confirm routing works without breaking existing pages.
  • Consider adding the new checklist link to other relevant navigation components for discoverability.

Worth double-checking

  • Potential mismatch in generated route types if the routeTree regeneration step is missed in CI.
  • If the public docs expose private API endpoint paths, ensure they remain stable and do not leak auth details.

Reviewer B · nemotron-3-120b-a12b — recommends ✅ merge
The PR adds a new documentation page for repo-owner onboarding checklist with corresponding tests and route updates. The content accurately reflects platform functionality, respects the public/private boundary (verified by isPublicSafeText test), and avoids forbidden terms. Changes are localized to UI documentation with no impact on core logic, APIs, or security boundaries.

No blocking issues spotted.

Route Viewport Before After
/docs desktop before desktop after desktop
mobile before mobile after mobile
/docs/owner-checklist desktop before desktop after desktop
mobile before mobile after mobile

Before = production · After = this PR's preview deploy.

@superagent-security

Copy link
Copy Markdown
Contributor

⚠️ Contributor trust inconclusive. Click here for more info: Superagent Dashboard

@ghost ghost added the reviewbot-review label Jun 20, 2026
@superagent-security

Copy link
Copy Markdown
Contributor

Superagent didn't find any vulnerabilities or security issues in this PR.

@codecov

codecov Bot commented Jun 20, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 96.60%. Comparing base (4d748c4) to head (115ec44).
⚠️ Report is 1 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #933   +/-   ##
=======================================
  Coverage   96.60%   96.60%           
=======================================
  Files         110      110           
  Lines       14926    14926           
  Branches     5398     5398           
=======================================
  Hits        14420    14420           
  Misses        104      104           
  Partials      402      402           

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@dosubot dosubot Bot added the lgtm label Jun 20, 2026
@JSONbored
JSONbored merged commit 4fe4332 into JSONbored:main Jun 20, 2026
18 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

gittensor:priority Maintainer-selected Gittensor priority — scores a 1.5x multiplier.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

docs(launch): create repo-owner onboarding checklist

2 participants