grafana/metrics-drilldown

docs: Add CLAUDE.md for Claude Code context

Open

#1,146 opened on Mar 18, 2026

View on GitHub
 (0 comments) (0 reactions) (1 assignee)TypeScript (12 forks)github user discovery
good first issuetype/docs

Repository metrics

Stars
 (27 stars)
PR merge metrics
 (PR metrics pending)

Description

Summary

Add a CLAUDE.md file to give Claude Code (and similar AI coding assistants) structured, project-specific context so that generated code aligns with our conventions from the start.

Motivation

We already document our conventions in docs/contributing.md and docs/application-structure.md, but AI tools don't automatically find these. CLAUDE.md is the standard entry point Claude Code reads at the start of every session. Putting key context there reduces the need to re-explain project norms in each conversation.

Proposed content

  • Package manager: pnpm (required)
  • Node version: 22+
  • Key commands: pnpm run test:ci, pnpm run lint, pnpm run typecheck, pnpm run build
  • Commit convention: Conventional Commits (feat/fix/docs/test/etc.)
  • Pointers to docs/contributing.md, docs/application-structure.md, docs/project-intent.md
  • Tech stack callouts: React + TypeScript, Grafana Scenes, Jest + Playwright

Contributor guide

Research direction
Create a CLAUDE.md file in the repository root with the proposed content: specify pnpm as package manager, Node 22+, key commands, commit convention, and pointers to existing docs.
Tech stack
typescriptreact
Domain
documentationdeveloper experience
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Git
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
90