Skip to content

docs(contributing): document every test:ci check, not just three - #3579

Merged
JSONbored merged 1 commit into
mainfrom
docs/selfhost-env-reference-gate-checklist
Jul 5, 2026
Merged

docs(contributing): document every test:ci check, not just three#3579
JSONbored merged 1 commit into
mainfrom
docs/selfhost-env-reference-gate-checklist

Conversation

@JSONbored

Copy link
Copy Markdown
Owner

Summary

  • .claude/skills/contributing-to-gittensory/{SKILL.md,reference.md} and AGENTS.md's
    "regenerate generated artifacts" guidance only named ui:openapi/cf-typegen/migrations.
    package.json's actual test:ci script runs eight more checks that weren't documented anywhere
    in the skill: db:schema-drift:check, selfhost:env-reference:check,
    selfhost:validate-observability, build:miner, test:miner-pack, rees:test,
    docs:drift-check, command-reference:check.
  • Added rows for all of them to reference.md's check table, added selfhost:env-reference and
    command-reference to SKILL.md's artifact-regeneration table, corrected SKILL.md's test:ci
    enumeration to match the real script, and pointed AGENTS.md's "five things" docs(site): align public docs with gittensor aesthetic #4 at the full list.

Test plan

  • Docs-only change under .claude/skills/** and AGENTS.md; no src/** impact.
  • Cross-checked every added command name against package.json's actual script definitions.

The contributing skill's generated-artifacts list and CI check table
only mentioned ui:openapi/cf-typegen/migrations, but package.json's
test:ci script runs eight more drift/build checks (db:schema-drift,
selfhost:env-reference, selfhost:validate-observability, build:miner,
test:miner-pack, rees:test, docs:drift-check, command-reference) that
were undocumented and could surprise a contributor who trusted the
skill's checklist as complete.
@superagent-security

Copy link
Copy Markdown
Contributor

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

@loopover-orb loopover-orb Bot added the gittensor:bug Gittensor-scored bug fix — scores a 0.05x multiplier. label Jul 5, 2026
@loopover-orb

loopover-orb Bot commented Jul 5, 2026

Copy link
Copy Markdown
Contributor

Warning

🟨🟨🟨🟨🟨🟨🟨🟨🟨🟨🟨🟨

⏸️ Gittensory review result - manual review recommended

Review updated: 2026-07-05 17:41:10 UTC

3 files · 1 AI reviewer · 2 blockers · readiness 100/100 · CI green · clean

⏸️ Suggested Action - Manual Review

  • No linked issue detected — If this PR is intended to solve an issue, link it explicitly in the PR body.
  • Maintainer requires a linked issue — Link the relevant issue (for example Closes #123) before opening the PR.

Review summary
Docs-only change that expands SKILL.md/reference.md/AGENTS.md to enumerate all test:ci sub-checks (schema-drift, selfhost env-reference, observability, miner build/pack, rees:test, docs-drift, command-reference) instead of the previous incomplete three-item summary, and adds a note pointing to package.json as the source of truth if the lists ever diverge. The diff only touches non-src documentation/skill files, carries no schema, migration, or code-path risk, and CI (including docs:drift-check) is green on this commit. The content is internally consistent — the new SKILL.md test:ci enumeration matches the reference.md table row-for-row — and the PR proactively hedges against future drift by naming package.json as canonical.

Nits — 3 non-blocking
  • The new Phase-4 table row in SKILL.md for selfhost:env-reference is a single very long parenthetical run-on sentence; consider splitting the caveat about line-shift staleness into a separate short note for scanability.
  • This documentation is now duplicated in three places (SKILL.md's inline enumeration, reference.md's table, and AGENTS.md's item 4) — the added 'script is the source of truth' caveat mitigates this but doesn't eliminate the three-way sync burden.
  • Nothing structural to change; if the check list is expected to grow further, consider having SKILL.md's Phase 5 section link to reference.md's table rather than re-enumerating the full list inline, to reduce future duplication (nit, not required here).

Concerns raised — review before merging

  • No linked issue detected — If this PR is intended to solve an issue, link it explicitly in the PR body.
  • Maintainer requires a linked issue — Link the relevant issue (for example Closes #123) before opening the PR.
Signal Result Evidence
Code review ❌ 2 blockers 1 reviewer
Linked issue ✅ No-issue rationale PR body explains why no issue is linked.
Related work ✅ No active overlap found No same-issue or scoped active PR overlap found.
Change scope ✅ 20/20 Low review scope from cached public metadata (no linked issue context).
Validation posture ✅ 25/25 PR body includes validation/test evidence.
Contributor workload ✅ 10/10 Author activity: 56 registered-repo PR(s), 46 merged, 521 issue(s).
Contributor context ✅ Confirmed Gittensor contributor JSONbored; Gittensor profile; 56 PR(s), 521 issue(s).
Gate result ❌ Blocking Repo-configured hard blocker found.
Review context
  • Author: JSONbored
  • Role context: owner (maintainer lane)
  • Public audience mode: oss maintainer
  • Lane context: Repository registration is not available in the local Gittensory cache.
  • Public profile languages: Python, TypeScript, JavaScript, Ruby, Go, Kotlin, MDX, Shell
  • Official Gittensor activity: 56 PR(s), 521 issue(s).
  • PR-specific overlap: none found.
Contributor next steps
  • Treat this as maintainer-lane context rather than normal contributor-lane activity.
  • No action.
  • Link the issue being solved, or explicitly explain why this is a no-issue PR.
Signal definitions
  • Related work = same linked issue, overlapping active PRs, or title/path similarity.
  • Change scope = cached public metadata such as size labels, draft state, and review-burden hints.
  • Validation posture = whether the PR provides enough public validation/test evidence for maintainer review.
  • Contributor workload = public contributor activity and cleanup pressure, not a repo-wide quality failure.
  • Contributor context = public GitHub/Gittensor identity context; non-Gittensor status is not a blocker.

🟩 Safe / merged · 🟦 Advisory · 🟨 Held for review · 🟥 Blocked / closed


💰 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.

  • Re-run Gittensory review

@loopover-orb loopover-orb Bot added the manual-review Gittensor contributor context label Jul 5, 2026
@JSONbored
JSONbored merged commit 7d0e2c4 into main Jul 5, 2026
8 checks passed
@JSONbored
JSONbored deleted the docs/selfhost-env-reference-gate-checklist branch July 5, 2026 17:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

gittensor:bug Gittensor-scored bug fix — scores a 0.05x multiplier. manual-review Gittensor contributor context

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant