Conversation
Brings @vtex/delivery-packages to AI Compliance Level 3 by adding the artifacts that orient AI agents and new engineers around this library's constraints. L1 — AGENTS.md + CLAUDE.md symlink + .agents/ and .claude/ structure L2 — .specify/memory/constitution.md + spec-kit configs L3 — Vendored vtex-agent-skills (specification, implementing) Library-specific adaptations: - Constitution and rules emphasize public-API discipline: every export from src/index.js is a contract with downstream consumers - A dedicated rule (20-api-discipline.md) classifies breaking vs non-breaking changes and documents the deprecation path - Test rule documents the tests/ folder convention (not colocated) and the shared fixtures (Order.json, mockGenerator.js) - Commands flag the rare cases where SDD Full applies (public API changes, dependency upgrades, cross-consumer breakages) - Husky escape hatches (lint-not-beta, test-not-beta) documented Stack documented: - Rollup 0.56 producing CJS + ESM dist outputs - Babel 6 with modules:false for production ESM emission - Jest 22 + ESLint 4 + Prettier - Husky 1 for pre-push gating - Single runtime dep: @vtex/estimate-calculator - Releases managed by Releasy (_releasy.json) Aligned with the spec-kit cleanup convention from vtex/portal-ui#115 / vtex/vcs.checkout-ui#1634 / vtex/checkout-confirmation-ui#187.
|
Lurian
approved these changes
May 15, 2026
Lurian
left a comment
Lurian
left a comment
There was a problem hiding this comment.
LGTM, só deixeis dois comentários sobre symlinks faltando
| | Tool | Reads from | Mechanism | | ||
| |---|---|---| | ||
| | Claude Code | `.claude/skills`, `.claude/commands`, `.claude/rules` | Symlinks → `../.agents/*` | | ||
| | Cursor | `.cursor/rules/` | Symlink → `../.agents/rules` | |
There was a problem hiding this comment.
O README documenta que Cursor lê as rules de .cursor/rules/ via symlink, mas esse arquivo não foi criado no PR.
Sem ele, agentes usando Cursor não terão as rules de 00-, 10- e 20- auto-attached nas conversas.
Sugestão de follow-up:
mkdir -p .cursor && ln -s ../.agents/rules .cursor/rules| |---|---|---| | ||
| | Claude Code | `.claude/skills`, `.claude/commands`, `.claude/rules` | Symlinks → `../.agents/*` | | ||
| | Cursor | `.cursor/rules/` | Symlink → `../.agents/rules` | | ||
| | Copilot | `.github/copilot-instructions.md` | Symlink → `../AGENTS.md` | |
There was a problem hiding this comment.
O README documenta que Copilot lê de .github/copilot-instructions.md (symlink para AGENTS.md), mas o arquivo não foi criado.
Sugestão de follow-up:
mkdir -p .github && ln -s ../AGENTS.md .github/copilot-instructions.md
|
Revisar o sonar também |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
AGENTS.mdwith library-specific posture (published npm library, public API contract discipline, Releasy-gated releases).agents/rules/with three rules: baseline stack (00), Jest 22 test discipline (10), and API breaking-change classification (20).agents/commands/for SDD Lite and SDD Full bootstrap workflowsspecificationandimplementingskills fromvtex/vtex-agent-skills.specify/memory/constitution.mdwith permanent, non-negotiable repo rulesspecs/README.mdanddocs/scope_of_work/README.md.gitignoreto exclude ephemeral SDD artifactsCompliance level
L1 → L2 → L3
Test plan
AGENTS.mdloads correctly in Claude Code (/help).claude/rules,.claude/skills,.claude/commandssymlinks resolve/specification "<task>"generates a spec inspecs//implementing "specs/<name>.md"runs the TDD loopplan.md,tasks.md,analysis.md) are gitignored