Skip to content

chore: claude setup#1777

Open
joanagmaia wants to merge 7 commits intomainfrom
chore/claude-setup
Open

chore: claude setup#1777
joanagmaia wants to merge 7 commits intomainfrom
chore/claude-setup

Conversation

@joanagmaia
Copy link
Collaborator

@joanagmaia joanagmaia commented Mar 25, 2026

This pull request adds new documentation and rules to the .claude/ directory to standardize development workflows, UI conventions, and documentation practices for the LFX Insights project. The changes provide clear guidelines for using the project's UI kit, managing the database locally, writing technical documentation, and running commands in a pnpm monorepo environment. It also updates the main CLAUDE.md to reflect new standards and corrects framework references.

.claude/
├── agents/
│   └── component-builder.md     # Specialized agent for building Vue UI using the project's uikit
├── commands/
│   ├── db-migrate.md             # /db-migrate — apply pending Flyway migrations to local Postgres
│   └── db-setup.md               # /db-setup — spin up a local Postgres container via Docker
├── rules/
│   ├── always-use-uikit.md       # Enforces use of uikit components over raw HTML in all Vue templates
│   └── pnpm-workspace-commands.md # Enforces pnpm (not npm/yarn) for all installs and scripts
├── skills/
│   └── tech-writer/
│       └── Skill.md              # Skill for writing public-facing docs for new features and changes
├── settings.json                 # Shared permission rules — what Claude can and cannot run automatically
└── settings.local.json           # Personal permission overrides (gitignored, not committed)
CLAUDE.md

New documentation and rules:

  • UI Development Standards:

    • Introduced a comprehensive guide for the component-builder agent, detailing how to build Vue 3 UI components using only the project's uikit, Tailwind, and PrimeVue, with specifics on file structure and Storybook stories. (.claude/agents/component-builder.md)
    • Added a rule enforcing the use of uikit components over raw HTML elements in all Vue templates, listing direct replacements and usage instructions. (.claude/rules/always-use-uikit.md)
  • Database Workflow Documentation:

    • Added a step-by-step guide for starting a local PostgreSQL instance with Docker, including port management, credentials, and teardown instructions. (.claude/commands/db-setup.md)
    • Documented the process for running and creating Flyway database migrations, including troubleshooting and migration file conventions. (.claude/commands/db-migrate.md)
  • Documentation Authoring Standards:

    • Provided detailed instructions for writing and structuring public-facing documentation using VitePress, including style, placement, and workflow for new features or changes. (.claude/skills/tech-writer/Skill.md)
  • Monorepo and Command Usage Rules:

    • Added workspace rules mandating the use of pnpm for all package management and script execution, with a command reference and rationale. (.claude/rules/pnpm-workspace-commands.md)
    • Introduced a .claude/settings.json file specifying command permissions for Claude Code, allowing safe operations and restricting destructive or sensitive actions. (.claude/settings.json)

Project documentation updates:

  • Main Guidance File:
    • Updated CLAUDE.md to reference the correct pnpm install --filter frontend command and changed the framework version from Nuxt 3 to Nuxt 4 for accuracy. [1] [2]

These additions and updates ensure all contributors follow consistent standards for UI development, database management, documentation, and workspace operations, improving maintainability and onboarding for the project.

Signed-off-by: Joana Maia <jmaia@contractor.linuxfoundation.org>
Signed-off-by: Joana Maia <jmaia@contractor.linuxfoundation.org>
Signed-off-by: Joana Maia <jmaia@contractor.linuxfoundation.org>
Copilot AI review requested due to automatic review settings March 25, 2026 16:37
@joanagmaia joanagmaia changed the title Chore/claude setup chore: claude setup Mar 25, 2026
Copy link

@github-actions github-actions bot left a comment

Choose a reason for hiding this comment

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

Conventional Commits FTW!

Copy link
Contributor

Copilot AI left a comment

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 set of Claude Code project guidelines under .claude/ to standardize UI component usage, pnpm monorepo workflows, local DB setup/migrations, and documentation authoring practices for the LFX Insights repo, plus aligns CLAUDE.md with current project structure and Nuxt version.

Changes:

  • Introduces new .claude/ agents, rules, commands, skills, and settings to codify development workflows and permissions.
  • Updates CLAUDE.md with corrected pnpm install guidance, Nuxt 4 reference, and expanded frontend directory structure.
  • Adds CLAUDE.local.md to .gitignore.

Reviewed changes

Copilot reviewed 8 out of 9 changed files in this pull request and generated 6 comments.

Show a summary per file
File Description
CLAUDE.md Updates repo guidance (pnpm filter, Nuxt 4) and expands documented frontend structure/setup modules.
.gitignore Ignores CLAUDE.local.md and normalizes **/AGENTS.md entry formatting.
.claude/skills/tech-writer/Skill.md Adds VitePress documentation authoring standards and workflow for public docs.
.claude/settings.json Adds Claude Code command/file permission allow/deny configuration.
.claude/rules/pnpm-workspace-commands.md Documents required pnpm workspace command conventions for installs and scripts.
.claude/rules/always-use-uikit.md Enforces replacing raw HTML primitives with the project uikit in Vue templates.
.claude/commands/db-setup.md Documents Docker-based local Postgres setup and applying Flyway migrations.
.claude/commands/db-migrate.md Documents applying/creating Flyway migrations and common troubleshooting.
.claude/agents/component-builder.md Adds a component-builder agent spec for building Vue UI with uikit + Tailwind + PrimeVue, including Storybook rules.
Comments suppressed due to low confidence (1)

CLAUDE.md:48

  • This section says “All paths below are relative to the frontend/ directory.”, but the tree that follows is rooted at frontend/ (suggesting paths are relative to the repo root). Please align these: either remove the leading frontend/ from the tree, or change the sentence to say paths are relative to the repository root.

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

joanagmaia and others added 3 commits March 25, 2026 16:43
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Signed-off-by: Joana Maia <jmaia@contractor.linuxfoundation.org>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Signed-off-by: Joana Maia <jmaia@contractor.linuxfoundation.org>
Signed-off-by: Joana Maia <jmaia@contractor.linuxfoundation.org>
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