Skip to content

docs(#536): open-source community-health files + README refresh#537

Merged
atlas-apex merged 5 commits into
devfrom
docs/GH-536-oss-community-health
Jun 6, 2026
Merged

docs(#536): open-source community-health files + README refresh#537
atlas-apex merged 5 commits into
devfrom
docs/GH-536-oss-community-health

Conversation

@atlas-apex

Copy link
Copy Markdown
Collaborator

Summary

Makes ApexYard read like a maintained, welcoming open-source project and fixes the README's long-stale component counts.

  • CONTRIBUTING.md — the fork → dev-branch → PR → Rex → CEO-merge flow, the conventions the hooks enforce (branch/PR-title/commit shapes), local checks (bin/run-hook-tests.sh, markdownlint, shellcheck), and when to add an AgDR. It documents the rules the repo already runs, so contributors hit the gates by construction.
  • .github/PULL_REQUEST_TEMPLATE.md — pre-fills the ## Summary / ## Testing / ## Glossary sections that validate-pr-create requires.
  • .github/ISSUE_TEMPLATE/ — Bug report + Feature request forms mirroring /bug and /feature, plus config.yml routing security → private advisories and questions → Discussions.
  • README refresh — badge row (License · Built-for-Claude-Code · Scorecard · PRs-welcome), a missing Architecture department (Tariq), a Contributors graphic, links to CONTRIBUTING + templates, and corrected counts: 40 hooks / 59 skills / 24 agents / 20 roles / 11 rules (were 18 / 33 / 5 / 19 / 8 — none of these were gated, so they'd silently drifted).
  • CLAUDE.md — integration-table "26 shell scripts" → 40.

Code of Conduct intentionally omitted per maintainer.

Testing

  1. npx markdownlint-cli2 on all 6 new/changed markdown files → 0 errors.
  2. bash .claude/hooks/tests/test_token_efficiency_wave1.sh → all invariants pass (CLAUDE.md skill table untouched).
  3. bash .claude/hooks/tests/test_site_counts.sh → site counts still match.
  4. bash bin/run-hook-tests.sh → PASS=65, FAIL=0.
  5. New README/CONTRIBUTING links point at existing targets (LICENSE, SECURITY.md, CONTRIBUTING.md, .claude/rules/, docs/multi-project.md) — the lychee link-check will confirm on CI.

Closes #536


Glossary

Term Definition
Community-health files GitHub-recognised CONTRIBUTING / SECURITY / issue + PR templates that signal a maintained OSS project and pre-shape contributions.
Badge row The shields.io status badges under the title (license, build-for, supply-chain score, PRs-welcome).
contrib.rocks A service that renders a repo's contributor avatars as an image for the README.
Ungated count A number in docs not verified by any CI check — free to drift; this PR corrects the drifted README/CLAUDE.md counts.

- CONTRIBUTING.md — fork → dev-branch → PR → Rex → CEO-merge flow, the hook-
  enforced conventions, local checks, and AgDR guidance (mirrors the rules the
  repo already runs)
- .github/PULL_REQUEST_TEMPLATE.md — Summary / Testing / Glossary (mirrors
  validate-pr-create + pr-quality)
- .github/ISSUE_TEMPLATE/ — Bug report + Feature request forms (mirror /bug and
  /feature) + config.yml routing security to private advisories and questions to
  Discussions
- README: badge row (License / Claude Code / Scorecard / PRs-welcome), an
  Architecture department + Contributors graphic, links to CONTRIBUTING/templates,
  and corrected component counts (40 hooks / 59 skills / 24 agents / 20 roles /
  11 rules — were 18/33/5/19/8)
- CLAUDE.md: integration-table hook count 26 → 40

(Code of Conduct intentionally omitted per maintainer.) All gated checks
(site-counts, token-efficiency, markdownlint, hook suite 65/65) stay green.

Closes #536

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>

@atlas-apex atlas-apex left a comment

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review: PR #537 (re-review)

Commit: 415e6ad6e9ab9f93f84d55924c735d40cfe0d56c

Summary

Re-review after one new commit (415e6ad). Verified the incremental diff between the previously-approved a166a96 and 415e6ad: it is solely the one-character typo fix I recommended — shellcleckshellcheck in CONTRIBUTING.md line 19. No other content changed (single file, +1/-1, same line).

Checklist Results

  • Architecture & Design: Pass (docs-only, no code)
  • Code Quality: Pass
  • Testing: N/A (no code)
  • Security: Pass
  • Performance: Pass
  • PR Description & Glossary: Pass
  • Summary Bullet Narrative: Pass
  • Technical Decisions (AgDR):N/A (no technical decisions)
  • Adopter Handbooks: N/A (no diff-matched handbooks)

Issues Found

None. The typo fix from the prior review is correctly applied.

Verdict

APPROVED


Reviewed by Rex (Code Reviewer Agent)
Reviewed commit: 415e6ad6e9ab9f93f84d55924c735d40cfe0d56c

me2resh and others added 2 commits June 6, 2026 18:31
…refs

- README Quick Start step 4: replace the manual `$EDITOR onboarding.yaml` flow
  with `/setup` (3-exchange config) + the #517 model (onboarding.yaml gitignored,
  copied from onboarding.example.yaml, commit-guard backstop)
- README step 3: recommend `/update` for upstream sync instead of a raw
  `git merge upstream/main`
- Correct the bug/feature guidance everywhere to the FRAMEWORK-feedback skills:
  `/report-apexyard-bug` + `/request-apexyard-feature` (file upstream to
  me2resh/apexyard) — distinct from `/bug`//feature, which file into your own
  project. Fixed in README Contributing step 1, CONTRIBUTING.md, and both
  issue-template comments.

Refs #536

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
…l YAML)

Projects join the portfolio via /handover (clones, scores, seeds docs, and
registers in apexyard.projects.yaml), with /setup seeding the first one — not a
hand-edited registry. Kept the manual `cp ...example` as an explicit fallback.
Steps 1-3 (fork/clone/add-upstream) stay manual by necessity — they run before
Claude Code is in the repo.

Refs #536

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>

@atlas-apex atlas-apex left a comment

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review (re-review): PR #537

Commit: b9cae7394190fa577fc9f372f74a858698d1e899

Summary

Single new commit b9cae73 since my last review at f6bc3e0. It rewrites README Quick Start step 5 from the manual cp apexyard.projects.yaml.example + $EDITOR flow to a skill-first one: projects join the portfolio via /handover <repo> (clones, scores harnessability, seeds docs, registers the repo in apexyard.projects.yaml, creating the registry on first use), with /setup seeding the first project. The manual cp is preserved as an explicit fallback parenthetical. Nothing else changed.

Re-review focus — all three verification points pass

  1. Claim accuracy — /handover registers projects. .claude/skills/handover/SKILL.md step 7 ("Append to the portfolio registry", L944) does the registry append, and L957 confirms it copies from apexyard.projects.yaml.example when the registry is missing — matching the README's "creating the registry on first use". /setup (L575–576) offers to register the first project. Both skills exist. ✅

  2. Diff scope. The incremental diff f6bc3e0..b9cae73 touches only the README step 5 region (and the one step-4 cross-reference sentence). No other content modified. ✅

  3. Lint / links / YAML block. CI markdownlint-cli2 and lychee both pass. The YAML reference block (version: 1 / projects: …) is intact, and the cp apexyard.projects.yaml.example fallback is preserved. ✅

    Note: a locally-installed newer markdownlint (cli2 v0.22.1) surfaces MD060 on README lines 152/243 — but those are pre-existing comparison-table rows, untouched by this PR, and MD060 postdates the repo's .markdownlint.json. Not a regression from this commit; CI's pinned linter is green.

Checklist Results

  • ✅ Architecture & Design: N/A (docs-only)
  • ✅ Code Quality: Pass
  • ✅ Testing: Pass (CI green: hook suite, markdownlint, lychee)
  • ✅ Security: Pass
  • ✅ Performance: N/A
  • ✅ PR Description & Glossary: Pass
  • ✅ Summary Bullet Narrative: Pass
  • ✅ Technical Decisions (AgDR):N/A (no technical decision; docs reflect existing skill behaviour)

Issues Found

None.

Verdict

APPROVED

The skill-first onboarding guidance is accurate against the actual /handover and /setup behaviour, the change is surgically scoped to step 5, and the fallback path is retained for operators who prefer manual editing.


🤖 Reviewed by Rex (Code Reviewer Agent)
📌 Reviewed commit: b9cae7394190fa577fc9f372f74a858698d1e899

…rd badge

- Embed site/og/index.png (the 1200x630 social-share card) centered at the
  top of the README, linked to the live site — makes the repo read as a
  branded project at a glance.
- Remove the OpenSSF Scorecard badge: it renders "invalid repo path" until
  scorecard.yml (#518) runs on main and publishes to the OpenSSF API, which
  only happens after v3.0.0 lands. A broken badge on the front page reads
  worse than no badge; re-add once it publishes post-release.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
@atlas-apex atlas-apex merged commit 6ac3373 into dev Jun 6, 2026
7 checks passed
@atlas-apex atlas-apex deleted the docs/GH-536-oss-community-health branch June 6, 2026 17:57
atlas-apex pushed a commit that referenced this pull request Jun 6, 2026
#537 folded into the release via the dev merge; record it in the
release notes so v3.0.0 documents the CONTRIBUTING / issue+PR templates /
SECURITY / README-banner work.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants