Skip to content

premium-analytics: add AGENTS.md, package docs, and research entries#49081

Open
dognose24 wants to merge 1 commit into
Automattic:trunkfrom
dognose24:upstream/premium-analytics-docs
Open

premium-analytics: add AGENTS.md, package docs, and research entries#49081
dognose24 wants to merge 1 commit into
Automattic:trunkfrom
dognose24:upstream/premium-analytics-docs

Conversation

@dognose24
Copy link
Copy Markdown
Contributor

@dognose24 dognose24 commented May 22, 2026

Proposed changes

Adds package-internal documentation for projects/packages/premium-analytics/:

  • AGENTS.md — package contract: chart invariants (*Unresponsive variants, withTooltips prop, CSS-subpath import), ESLint patterns, the @wordpress/boot shim, route-addition rules, and a Linear-issue contract for agent-driven task implementation.
  • CLAUDE.md — single-line pointer to AGENTS.md.
  • docs/add-route.md — step-by-step for adding a new route under routes/.
  • docs/research/eslint-disable-line-discovery.md — 6-round forensic trail of the eslint-disable-line directive saga on @automattic/charts/style.css. Current invariant: don't add the directive; the rule never fires on this import and pre-commit autofix-strips unused disables. The doc preserves the wrong-but-plausible mechanisms each round ruled out, so future maintainers don't re-run the cycle.
  • changelog/ — 8 internal-tooling-only entries (Comment:-form, no user-facing change).

What this PR is / isn't

  • Is: pure docs additions, all in one package. No code, behavior, dependency, or build-step changes.
  • Isn't: a structural change. Boot chain, route registration, REST endpoints — all unchanged.

Why parallel batch

This is one of 4 PRs upstreaming accumulated work from dognose24/jetpack. Each PR has a self-contained scope and can be reviewed independently:

No PR depends on another to compile / lint / test. PR #B has a cosmetic forward-reference to PR #C's skills in README.md; PR #C references PR #B's paths inside the skill bodies. This PR is fully independent of the other three.

Does this pull request change what data or activity we track or use?

No. Documentation-only addition; nothing is fetched, persisted, or tracked.

Testing instructions

  1. Read projects/packages/premium-analytics/AGENTS.md — should be coherent on its own.
  2. Spot-check docs/research/eslint-disable-line-discovery.md reads as historical receipt of the directive saga (Rounds 1–6), not a current operational rule.
  3. Confirm none of the 8 changelog entries are user-facing (all are Comment:-form).

🤖 Generated with Claude Code

Adds package-internal documentation that codifies conventions discovered
during recent chart-task work in this package:

* AGENTS.md — package contract covering chart invariants
  (Unresponsive variants, withTooltips, CSS subpath import), ESLint
  patterns, the @wordpress/boot shim, route additions, and the
  Linear-issue contract for /premium-analytics-implement-task.
* CLAUDE.md — single-line pointer to AGENTS.md.
* docs/add-route.md — sequence for adding a new route under routes/.
* docs/research/eslint-disable-line-discovery.md — 6-round forensic
  trail for the eslint-disable directive on the @automattic/charts
  CSS-subpath import (currently retired per Round 6: the rule never
  fires; the directive is autofix-stripped).
* changelog/ — eight internal-tooling-only entries (Comment-form,
  no user-facing change) capturing the chain of internal docs work.

Pure additions; no behavior, dependency, or boot-chain changes.

🤖 Generated with [Claude Code](https://claude.com/claude-code)
@github-actions
Copy link
Copy Markdown
Contributor

Thank you for your PR!

When contributing to Jetpack, we have a few suggestions that can help us test and review your patch:

  • ✅ Include a description of your PR changes.
  • ✅ Add testing instructions.
  • ✅ Specify whether this PR includes any changes to data or privacy.
  • ✅ Add changelog entries to affected projects

This comment will be updated as you work on your PR and make changes. If you think that some of those checks are not needed for your PR, please explain why you think so. Thanks for cooperation 🤖


@github-actions github-actions Bot added the OSS Citizen This Pull Request was opened by an Open Source contributor. label May 22, 2026
@dognose24 dognose24 self-assigned this May 22, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Docs OSS Citizen This Pull Request was opened by an Open Source contributor. [Package] Premium Analytics

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant