Skip to content

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

Closed
oktofeesh1 wants to merge 2 commits into
JSONbored:mainfrom
oktofeesh1:feat/issue-254-owner-checklist
Closed

docs(launch): repo-owner onboarding checklist (#254)#932
oktofeesh1 wants to merge 2 commits into
JSONbored:mainfrom
oktofeesh1:feat/issue-254-owner-checklist

Conversation

@oktofeesh1

Copy link
Copy Markdown
Contributor

Fixes #254.

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.

Checklist sections (each grounded in real code)

  1. Repository registrationready + blockers from the readiness report.
  2. Repo policy & config quality.gittensory.yml (settings/gate/review), configQuality band; preview via POST /v1/repos/:owner/:repo/settings-preview.
  3. Labels & trusted pipelinelabelPolicy.trustedPipelineReady, missing/unused registry labels.
  4. Issue quality — clear issues reduce low-quality PR pressure.
  5. Contribution lanesParticipationLane (direct_pr / issue_discovery / split / inactive / unknown); GET /v1/repos/:owner/:repo/gittensor-config-recommendation.
  6. Validation expectations & gate readinesstestCoverageHealth (gate_ready / gate_unknown).
  7. Maintainer capacity & queue healthqueueHealth, maintainerCutReadiness.
  8. Public/private boundariespublicSurface / commentMode / publicAudienceMode, quiet by default, sanitizer scrubs anything economic/identifying.

Acceptance criteria

  • Covers repo policy, labels, issue quality, validation commands, maintainer capacity, contribution lanes, and public/private boundaries.
  • Includes 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).
  • Links to the owner workflow (beta onboarding) and onboarding/privacy surfaces.

Public-output safety

The public/private section names what the canonical sanitizer scrubs. test/unit/docs-owner-checklist.test.ts mirrors the miner-quickstart doc test: asserts every required dimension, the real endpoints/profile, the lane taxonomy, the honest tradeoffs, the owner-workflow links, and the absence of reward-guarantee / score-prediction / seed-phrase·mnemonic·private-key copy.

Notes

  • Pure docs addition; apps/** is excluded from coverage, so no coverage impact. Endpoints, the repo-owner-intake agent profile, and the lane taxonomy were verified against src/api/routes.ts, packages/gittensory-mcp/bin/gittensory-mcp.js, and src/signals/{registration-readiness,engine}.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:18
@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 #932 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 — Not merged

Reviewed 4 changed file(s) — two independent AI reviewers, synthesized.

ℹ️ This PR conflicts with main and can't be merged as-is. Conflicting file(s): apps/gittensory-ui/src/routeTree.gen.ts, apps/gittensory-ui/src/routes/docs.index.tsx, apps/gittensory-ui/src/routes/docs.owner-checklist.tsx, test/unit/docs-owner-checklist.test.ts. Resolve the conflict(s) and open a fresh PR.

Merge readiness: ✅ Mergeable (conflicting) · all CI checks green/neutral/skipped.

Summary

Adds a new documentation page for repo‑owner onboarding, integrates it into the route tree, updates the docs index navigation, and includes comprehensive unit tests. No correctness bugs, security concerns, or test failures are evident. The page respects the public/private sanitizer and avoids forbidden terminology.

💡 Nits — non-blocking, optional

  • Meta titles contain encoded characters (â��) likely from copy‑paste; replace with proper dash.
  • Import list in routeTree.gen.ts could be sorted alphabetically.
  • OwnerChecklist component lacks a comment describing its purpose.
  • Consider normalizing the em‑dash characters in meta titles/descriptions (use a plain "-" or proper Unicode dash).
  • Keep the import ordering in routeTree.gen.ts alphabetical for consistency.
  • Add a brief JSDoc comment to the OwnerChecklist component for future maintainers.
  • Consider adding a brief introduction to the checklist to provide context for new repo owners.
  • Ensure that the links to external resources are up-to-date and functional.
  • Review the accessibility of the new documentation page to ensure it meets the project's standards.

This repo uses one-shot review: a rejected PR is closed, not iterated in place. Address the above and open a new focused PR.

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.

@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 (725b405).
⚠️ Report is 29 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #932   +/-   ##
=======================================
  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.

@superagent-security

superagent-security Bot commented Jun 20, 2026

Copy link
Copy Markdown
Contributor

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

@ghost ghost closed this Jun 20, 2026
@ghost ghost removed reviewbot-review labels Jun 20, 2026
@JSONbored JSONbored reopened this Jun 21, 2026
@ghost ghost closed this Jun 21, 2026
@JSONbored JSONbored reopened this Jun 21, 2026
@ghost ghost closed this Jun 21, 2026
@JSONbored JSONbored reopened this Jun 21, 2026
@ghost ghost closed this Jun 21, 2026
@JSONbored JSONbored reopened this Jun 21, 2026
@ghost ghost closed this Jun 21, 2026
@JSONbored JSONbored reopened this Jun 21, 2026
@ghost ghost closed this Jun 21, 2026
This pull request was closed.
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