Skip to content

chore: public-readiness prep — LICENSE, docs, cleanup - #49

Open
Adi-ty wants to merge 2 commits into
mainfrom
chore/public-readiness
Open

chore: public-readiness prep — LICENSE, docs, cleanup#49
Adi-ty wants to merge 2 commits into
mainfrom
chore/public-readiness

Conversation

@Adi-ty

@Adi-ty Adi-ty commented Jul 30, 2026

Copy link
Copy Markdown
Collaborator

What this PR does

Prepares the repo for public consumption — removes internal AI agent artifacts, adds LICENSE files to every package, and writes contributor/onboarding documentation.

Changes

  • LICENSE (GPL-2.0-or-later) added to all 6 packages — node-packages/* and composer-packages/*. Each subtree-split target (mirror repo / npm branch) carries its own copy; the root LICENSE doesn't propagate across the split boundary.
  • AGENTS.md — repo-wide conventions, directory map, test commands, architectural decisions, and common pitfalls for AI tooling contributors.
  • CONTRIBUTING.md — human-focused setup guide and PR checklist.
  • README.md — top-level package overview table (npm + Composer) directing readers to each package's own README.
  • CLAUDE.md — reduced to a single @AGENTS.md include (consumed by Claude Code sessions).
  • Internal .claude/ directory deleted — issue work-logs, handoff script, templates. These are per-session artifacts, not public source.
  • .gitattributes, PR/issue templates — stripped all .claude/ references.
  • Package READMEs — all six gain a License section + rtCamp banner.
  • CHANGELOGs — tagged [1.0.0] for every npm package that had unreleased entries.
  • composer-packages/phpcs/composer.json — added composer test script (phpunit).
  • package-lock.json — regenerated.

Verification

  • npm run check passes
  • (cd composer-packages/phpcs && composer install && composer test) passes
  • (cd composer-packages/phpstan && composer install && composer test) passes

Housekeeping

  • CHANGELOG.md entries already present for each package

- Add LICENSE (GPL-2.0-or-later) to all 6 packages (critical for subtree-split)
- Add AGENTS.md, CONTRIBUTING.md, README.md at root
- Remove internal .claude/ work-logs and .claude references from templates
- Update all package READMEs with license/rtCamp banner
- Tag CHANGELOGs at [1.0.0] and add composer test script to phpcs
- Regenerate package-lock.json
@Adi-ty
Adi-ty marked this pull request as ready for review July 30, 2026 10:21
Copilot AI review requested due to automatic review settings July 30, 2026 10:21

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Pull request overview

Note

Copilot couldn't run its full agentic review because it didn't start before the timeout. Make sure your repository has a runner available, or add a copilot-code-review.yml file specifying one with the runs-on attribute. See the docs for more details.

Prepares the repository for public release by removing internal AI agent artifacts, standardising licensing across packages, and improving contributor/onboarding documentation for both npm and Composer subtrees.

Changes:

  • Added GPL-2.0-or-later LICENSE files and updated package READMEs to reference them.
  • Added root-level onboarding docs (AGENTS.md, CONTRIBUTING.md) and refocused CLAUDE.md to a single include.
  • Promoted multiple packages to 1.0.0 and converted CHANGELOG “Unreleased” sections into dated 1.0.0 entries.

Reviewed changes

Copilot reviewed 36 out of 37 changed files in this pull request and generated 1 comment.

Show a summary per file
File Description
node-packages/wp-tooling/package.json Bumps package version/dev dependency for 1.0.0 readiness.
node-packages/wp-tooling/README.md Removes internal agent references; points contributors to monorepo docs; adds license + banner.
node-packages/wp-tooling/LICENSE Adds GPL-2.0 text for subtree-split portability.
node-packages/wp-tooling/CHANGELOG.md Tags entries as 1.0.0 with a release date.
node-packages/wp-tooling/AGENTS.md Adds package-specific contributor rules and architecture notes.
node-packages/tailwind-config/package.json Bumps version and eslint-config dev dependency to 1.0.0.
node-packages/tailwind-config/README.md Adds license section + banner.
node-packages/tailwind-config/LICENSE Adds GPL-2.0 text for subtree-split portability.
node-packages/tailwind-config/CHANGELOG.md Tags entries as 1.0.0 with a release date.
node-packages/stylelint-config/package.json Bumps version and eslint-config dev dependency to 1.0.0.
node-packages/stylelint-config/README.md Adds license section + banner.
node-packages/stylelint-config/LICENSE Adds GPL-2.0 text for subtree-split portability.
node-packages/stylelint-config/CHANGELOG.md Tags entries as 1.0.0 with a release date.
node-packages/eslint-config/package.json Bumps version to 1.0.0.
node-packages/eslint-config/README.md Adds license section + banner.
node-packages/eslint-config/LICENSE Adds GPL-2.0 text for subtree-split portability.
node-packages/eslint-config/CHANGELOG.md Tags entries as 1.0.0 with a release date.
composer-packages/phpstan/README.md Adds license section + banner.
composer-packages/phpstan/LICENSE Adds GPL-2.0 text for subtree-split portability.
composer-packages/phpcs/composer.json Adds a composer test script.
composer-packages/phpcs/README.md Adds license section + banner.
composer-packages/phpcs/LICENSE Adds GPL-2.0 text for subtree-split portability.
README.md Adds top-level package overview and repo entry-point documentation.
CONTRIBUTING.md Adds contributor setup and PR checklist for both ecosystems.
CLAUDE.md Replaces detailed internal guidance with a single include reference.
AGENTS.md Adds monorepo-wide dev/test guidance and release mechanics notes.
.github/pull_request_template.md Removes references to internal .claude issue logs.
.github/ISSUE_TEMPLATE/task.md Removes references to internal .claude issue logs.
.gitattributes Removes merge strategy for deleted .claude artifacts.
.claude/issues/_TEMPLATE.md Deletes internal per-issue Claude template.
.claude/issues/9-git-hooks.md Deletes internal Claude issue log artifact.
.claude/issues/8-release-scripts.md Deletes internal Claude issue log artifact.
.claude/issues/6-detect-changes.md Deletes internal Claude issue log artifact.
.claude/issues/29-remote-scaffold-sources.md Deletes internal Claude issue log artifact.
.claude/issues/10-version-monitor-scripts.md Deletes internal Claude issue log artifact.
.claude/commands/handoff.md Deletes internal Claude “skill” artifact.
Comments suppressed due to low confidence (3)

node-packages/wp-tooling/README.md:1

  • These relative links point outside the package directory. In subtree-split targets (e.g. npm/wp-tooling branch or a mirror), ../../AGENTS.md and ../../CONTRIBUTING.md likely won’t exist, resulting in broken docs. Consider linking to ./AGENTS.md (package-local rules) and either duplicating a minimal CONTRIBUTING section into this package or linking to a public canonical URL that will exist in the split.
    node-packages/wp-tooling/CHANGELOG.md:1
  • The CHANGELOG conversion replaces ## Unreleased with a release heading but doesn’t add a fresh ## Unreleased section above it (per Keep a Changelog). This also conflicts with the new CONTRIBUTING checklist item that asks contributors to add entries under ## Unreleased. Recommendation: reintroduce an empty ## Unreleased section at the top (above [1.0.0]) for ongoing development notes.
    node-packages/wp-tooling/README.md:1
  • The README hotlinks a banner image from an external CDN domain. If that asset becomes unavailable (or is blocked by a corporate proxy), the README will degrade with a broken image. Consider storing the banner in-repo (or using a stable GitHub-hosted asset URL) to improve reliability for public consumption.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread README.md
Comment on lines +8 to +13
| Package | What it is |
| --- | --- |
| [`@rtcamp/wp-tooling`](node-packages/wp-tooling) | TTY UI toolkit, scaffold registry, release scripts, git hooks, CI helpers, version monitor — the CLI consumed by every rtCamp plugin/theme skeleton |
| [`@rtcamp/eslint-config`](node-packages/eslint-config) | Shareable ESLint flat config, extends `@wordpress/eslint-plugin` |
| [`@rtcamp/stylelint-config`](node-packages/stylelint-config) | Shareable Stylelint config, extends `@wordpress/stylelint-config` |
| [`@rtcamp/tailwind-config`](node-packages/tailwind-config) | Tailwind CSS v4 PostCSS config + `theme.json` webpack plugin |
Copilot AI review requested due to automatic review settings July 30, 2026 11:24

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Pull request overview

Copilot reviewed 39 out of 40 changed files in this pull request and generated no new comments.

Comments suppressed due to low confidence (2)

node-packages/wp-tooling/README.md:1

  • These relative links point outside the package directory, which will break in subtree-split targets (mirror repos / npm/<dirname> branches) and any future npm publish where monorepo-root files aren’t present. Prefer linking to package-local docs (e.g., this package already has ./AGENTS.md) and/or use absolute GitHub URLs for monorepo-root docs so the README remains valid when consumed standalone.
    node-packages/wp-tooling/CHANGELOG.md:1
  • Renaming ## Unreleased directly to a version header removes the Unreleased section entirely, which conflicts with the workflow described in CONTRIBUTING.md (new entries go under ## Unreleased) and makes future changes harder to stage. Consider reintroducing a fresh ## Unreleased section above 1.0.0 (Keep a Changelog pattern), and apply the same fix to the other package changelogs updated in this PR.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants