Skip to content

Commit 228fcb5

Browse files
docs: improve CLAUDE.md and add enforcement contact to CODE_OF_CONDUCT
Add pre-commit hook setup, release process, generated .cursor/ warning, and dual naming clarification to CLAUDE.md. Remove verbose agent/skill listings. Add enforcement email to Code of Conduct.
1 parent 8d12b41 commit 228fcb5

2 files changed

Lines changed: 37 additions & 16 deletions

File tree

β€ŽCLAUDE.mdβ€Ž

Lines changed: 34 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -4,15 +4,14 @@ This file provides guidance to Claude Code (claude.ai/code) when working with co
44

55
## Project Overview
66

7-
**Salesforce Claude Code (SCC)** is an agent harness performance system β€” a Claude Code plugin providing production-ready agents, skills, hooks, and MCP configurations specifically for Salesforce development. Published as `scc-universal` on npm. Works across Claude Code and Cursor.
7+
**Salesforce Claude Code (SCC)** is an agent harness performance system β€” a Claude Code plugin providing production-ready agents, skills, hooks, and MCP configurations specifically for Salesforce development. Works across Claude Code and Cursor.
88

9-
This is the root directory for all SCC source code.
9+
- **npm package:** `scc-universal` (CLI install name)
10+
- **Plugin name:** `salesforce-claude-code` (marketplace display name)
1011

1112
## Build & Test Commands
1213

1314
```bash
14-
cd salesforce-claude-code
15-
1615
# Install dependencies
1716
npm install
1817

@@ -31,7 +30,6 @@ node tests/hooks/hooks.test.js
3130

3231
# Run individual CI validators
3332
node scripts/ci/validate-agents.js
34-
node scripts/ci/validate-commands.js
3533
node scripts/ci/validate-skills.js
3634
node scripts/ci/validate-hooks.js
3735
node scripts/ci/validate-install-manifests.js
@@ -40,36 +38,41 @@ node scripts/ci/validate-no-personal-paths.js
4038
# Lint (ESLint + markdownlint)
4139
npm run lint
4240

41+
# Auto-fix markdownlint errors
42+
npx markdownlint '**/*.md' --ignore node_modules --fix
43+
4344
# Coverage (80% lines/functions/branches/statements required)
4445
npm run coverage
4546

4647
# SCC CLI
47-
npx scc install <language> # Install SCC content for a language (apex, lwc, all)
48+
npx scc install <target> # Install SCC content (apex, lwc, all)
4849
npx scc doctor # Diagnose missing/drifted files
4950
npx scc repair # Restore drifted files
5051
npx scc status # Query JSON state store
51-
npx scc sessions # List/inspect sessions
5252
npx scc uninstall # Remove SCC-managed files
5353
npx scc plan # Preview files to be installed (dry run)
5454
npx scc list-installed # Show currently installed SCC files
55-
npx scc session-inspect # Inspect a specific session's details
5655
```
5756

5857
## Architecture
5958

6059
The project is a **plugin system** β€” mostly Markdown/JSON content consumed by AI agent harnesses, backed by Node.js scripts for installation, hooks, and validation.
6160

62-
### Core Content Directories (Markdown + YAML frontmatter)
61+
### Core Content (Markdown + YAML frontmatter)
6362

64-
- **agents/** β€” 25 specialized subagents (sf-apex-reviewer, sf-lwc-reviewer, sf-tdd-guide, sf-security-reviewer, sf-trigger-architect, sf-flow-reviewer, sf-agentforce-builder, sf-performance-optimizer, sf-integration-architect, sf-code-reviewer, doc-updater, sf-e2e-runner, refactor-cleaner, sf-architect, sf-build-resolver, loop-operator, sf-admin, sf-visualforce-reviewer, sf-aura-reviewer, sf-verification-runner, sf-blueprint-planner, sf-devops-deployment, deep-researcher, learning-engine, eval-runner). Format: Markdown with YAML frontmatter (`name`, `description`, `tools`, `model`).
65-
- **skills/** β€” 55 workflow/domain-knowledge modules (35 with `user-invocable: true` for direct invocation via `/skill-name`; 20 are auto-activating context skills). Includes Salesforce-specific skills, platform skills, and workflow skills (sf-help, sf-quickstart, sf-build-fix, sf-harness-audit, checkpoint, sf-docs-lookup, refactor-clean, save-session, resume-session, sessions, update-docs, aside, model-route). Format: Markdown with YAML frontmatter (`name`, `description`, `origin`, `user-invocable`) in `skills/<name>/SKILL.md` directories.
63+
- **agents/** β€” 25 specialized subagents. Format: Markdown with YAML frontmatter (`name`, `description`, `tools`, `model`, `origin`, `readonly`).
64+
- **skills/** β€” 55 workflow/domain-knowledge modules (35 user-invocable, 20 auto-activating). Format: `skills/<name>/SKILL.md` with YAML frontmatter (`name`, `description`, `origin`, `user-invocable`).
6665
- **hooks/hooks.json** β€” Claude Code hook lifecycle (SessionStart, PreToolUse, PostToolUse, PostToolUseFailure, PreCompact, Stop, SessionEnd). Hook scripts live in `scripts/hooks/`.
6766

67+
### Generated Content (Never Edit Directly)
68+
69+
- **.cursor/** β€” Auto-generated from `agents/` and `skills/` by `npm run build`. The pre-commit hook enforces sync. Always edit the source in `agents/` or `skills/`, then run `npm run build` and stage `.cursor/`.
70+
6871
### Script Infrastructure (Node.js, CommonJS)
6972

7073
- **scripts/scc.js** β€” Main CLI entry point (`npx scc`).
7174
- **scripts/cli/** β€” End-user CLI commands (install, uninstall).
72-
- **scripts/dev/** β€” Contributor/dev tools (doctor, repair, status, build-cursor, harness-audit, etc.).
75+
- **scripts/dev/** β€” Contributor/dev tools (doctor, repair, status, build-cursor, harness-audit).
7376
- **scripts/lib/** β€” Shared utilities (package-manager detection, install executor, JSON state store, adapters).
7477
- **scripts/hooks/** β€” Hook implementations. Uses `run-with-flags.js` for profile-based gating.
7578
- **scripts/ci/** β€” CI validators enforcing structure/frontmatter of all content types.
@@ -79,11 +82,28 @@ The project is a **plugin system** β€” mostly Markdown/JSON content consumed by
7982
### Cross-Harness Support
8083

8184
- **.claude-plugin/** β€” Plugin manifest for Claude Code marketplace.
82-
- **.cursor/** β€” Cursor IDE skills, agents, and hooks.
85+
- **.cursor-plugin/** β€” Plugin manifest for Cursor marketplace.
86+
87+
## Pre-commit Hook
88+
89+
The pre-commit hook (`.githooks/pre-commit`) mirrors CI locally: build, ESLint, markdownlint, all 6 validators, and full test suite. Setup for new contributors:
90+
91+
```bash
92+
git config core.hooksPath .githooks
93+
```
94+
95+
## Release Process
96+
97+
Versioning is automated via release-please. On merge to `main`:
98+
99+
1. Release-please creates a Release PR bumping `package.json` and all 4 plugin manifests (`.claude-plugin/plugin.json`, `.claude-plugin/marketplace.json`, `.cursor-plugin/plugin.json`, `.cursor-plugin/marketplace.json`).
100+
2. Merging the Release PR triggers `npm publish --provenance --access public`.
101+
102+
Conventional commit types drive version bumps: `feat:` β†’ minor, `fix:` β†’ patch, `feat!:` β†’ major.
83103

84104
## Key Conventions
85105

86-
- **Target Salesforce API version: 66.0 (Spring '26)**. Skills and code examples target this version. When referencing API-version-specific features (SOQL Cursors, RunRelevantTests, @testFor), always note the minimum version required.
106+
- **Target Salesforce API version: 66.0 (Spring '26)**. When referencing API-version-specific features (SOQL Cursors, RunRelevantTests, @testFor), always note the minimum version required.
87107
- **Node.js >= 20** required. Pinned: Node 20.19.0, Python 3.12.8 (`.tool-versions`).
88108
- **CommonJS throughout** β€” all scripts use `require()`/`module.exports`.
89109
- **File naming** β€” lowercase with hyphens (e.g., `sf-apex-reviewer.md`, `sf-trigger-frameworks`).

β€ŽCODE_OF_CONDUCT.mdβ€Ž

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -59,8 +59,9 @@ representative at an online or offline event.
5959
## Enforcement
6060

6161
Instances of abusive, harassing, or otherwise unacceptable behavior may be
62-
reported to the community leaders responsible for enforcement.
63-
All complaints will be reviewed and investigated promptly and fairly.
62+
reported to the community leaders responsible for enforcement at
63+
**<jitencseng@gmail.com>**. All complaints will be reviewed and investigated
64+
promptly and fairly.
6465

6566
All community leaders are obligated to respect the privacy and security of the
6667
reporter of any incident.

0 commit comments

Comments
Β (0)