Files

T

Chris Farhood 6930b7a258 Optimize SDLC and coding-standards skills, remove duplication

SDLC skill (250 → ~127 lines):
- Remove Hugh-exclusive .github/workflows/ language; engineers share access
- Condense 48-hour SLA from 38 to 8 lines
- Replace verbose 5-stage pipeline description with compact diagrams
- Condense handoff protocol from 17 to 5 lines
- Remove status transition rules table (redundant with handoff protocol)
- Remove agent roster (agents have UUIDs in their own AGENTS.md)
- Remove work distribution section (redundant with agent instructions)

Coding-standards skill:
- Add SemVer, ArtifactHub distribution, ghcr.io registry rules
- Add Renovate/Dependabot, no-package-mirrors, npm-audit rules
- These were previously only in individual AGENTS.md files

Part of PRI-1094 — agent and process review.

Co-Authored-By: Paperclip <noreply@paperclip.ing>

2026-05-09 15:29:08 +00:00

2.7 KiB

Raw Permalink Blame History

name, description

name	description
coding-standards	Coding standards for Privileged Escalation. Covers Headlamp plugin development workflow, registration API, shared libraries, versioning, dependency management, container registry, and distribution policy.

Coding Standards

Headlamp Plugins

All plugins extend Headlamp, a Kubernetes dashboard with a plugin system.

Language: TypeScript + React 18, MUI v5
Scaffolding: npx --yes @kinvolk/headlamp-plugin create <plugin-name>
Entry point: src/index.tsx
Linting: ESLint via @headlamp-k8s/eslint-config + Prettier
Testing: Vitest + React Testing Library

Plugin Commands

Run from the plugin directory:

Command	Purpose
`npm run start`	Dev mode with hot reload
`npm run build`	Production build (`dist/main.js`)
`npm run format`	Prettier format
`npm run lint`	ESLint check
`npm run lint-fix`	ESLint auto-fix
`npm run tsc`	Typecheck
`npm run test`	Vitest tests

Registration API

Import from @kinvolk/headlamp-plugin/lib:

registerAppBarAction() — add components to the nav bar
registerRoute() — create new pages
registerSidebarEntry() — add sidebar items
registerDetailsViewSection() — extend resource detail views
registerPluginSettings() — add plugin configuration UI

K8s API Access

import { K8s } from '@kinvolk/headlamp-plugin/lib';
const [pods, error] = K8s.ResourceClasses.Pod.useList();

Shared Libraries

These are provided by Headlamp at runtime — do not bundle them: React, React Router, Redux, MUI, Lodash, Monaco Editor, Notistack, Iconify.

Versioning & Distribution

All releases use SemVer. ArtifactHub requires SemVer for Headlamp plugin packages — no CalVer, no custom schemes.
Plugin distribution is ArtifactHub only. Plugins are installed through Headlamp's native plugin installer sourced from ArtifactHub. No Helm charts, install scripts, or custom install mechanisms.
Container images go to ghcr.io only. Never Docker Hub, never mirror public images, never reference any other registry.

Dependency Management

Dependency updates are owned by Mend Renovate. Never enable Dependabot, never create .github/dependabot.yml, never reference Dependabot in workflows or docs.
No package mirrors. Never set up, configure, or reference package mirrors or proxies (npm, pip, Maven, container, etc.). Always use upstream registries directly.
Security scanning uses local tools. Run npm audit or pnpm audit for vulnerability scanning. Do not use the GitHub vulnerability alerts API.

2.7 KiB Raw Permalink Blame History