Skip to content

feat: ai tooling create claude.md - #3783

Open
maxiroellplenty wants to merge 1 commit into
stablefrom
ai-tooling/claude.md
Open

feat: ai tooling create claude.md#3783
maxiroellplenty wants to merge 1 commit into
stablefrom
ai-tooling/claude.md

Conversation

@maxiroellplenty

Copy link
Copy Markdown
Contributor

All changes meet the following requirements

  • Changelog entry was added
  • Changes have been documented
  • Changes have been tested by the author
  • Changes have been tested by the reviewer
  • Changes to SCSS have been accounted for in plentyShop LTS Modern

@plentymarkets/plentyshop

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

Adds a CLAUDE.md repository guide describing this plugin’s architecture, build workflow, and key conventions to help AI-assisted tooling (and humans) work effectively within the Ceres / plentyShop LTS codebase.

Changes:

  • Introduces CLAUDE.md with a concise, project-specific overview (PHP plugin architecture, IO dependency, templates/contexts/widgets).
  • Documents local development commands and build/test limitations (Node/webpack pipeline, dist assets, available tests).
  • Captures key conventions and contribution workflow expectations (widgets registries, translations, branching/changelog notes).

💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

Comment thread CLAUDE.md
Comment on lines +170 to +172
- `npm run compareTranslations` treats **`de` as the source of truth** and compares key presence only, never values. It is not wired into CI and does **not** currently pass — it reports every `Config`/`Widget`/`Wizard`/`Page` key as missing from fr/nl/pl by design. Read its output selectively; don't try to make it clean.
- ESLint is `google` config with heavy overrides ([.eslintrc.json](.eslintrc.json)): **Allman brace style**, 4-space indent, double quotes, no trailing commas, `object-curly-spacing: always`, min identifier length 2 (except `$`, `i`, `j`, `k`), comments on their own line above code.
- Stylelint is `stylelint-config-twbs-bootstrap` with `border-radius`, `transition` and `calc()` **blacklisted** ([.stylelintrc](.stylelintrc)) — use the project's mixins/variables instead.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

question: Why is this information important when the commands are already included in the list above? I don't think the model cares much about the origin of the rules.

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.

3 participants