mirror of
https://github.com/affaan-m/everything-claude-code.git
synced 2026-04-02 10:39:23 +00:00
feat: add everything-claude-code-conventions ECC bundle (.agents/skills/everything-claude-code/SKILL.md)
This commit is contained in:
@@ -5,7 +5,7 @@ description: Development conventions and patterns for everything-claude-code. Ja
|
|||||||
|
|
||||||
# Everything Claude Code Conventions
|
# Everything Claude Code Conventions
|
||||||
|
|
||||||
> Generated from [affaan-m/everything-claude-code](https://github.com/affaan-m/everything-claude-code) on 2026-03-20
|
> Generated from [affaan-m/everything-claude-code](https://github.com/affaan-m/everything-claude-code) on 2026-04-02
|
||||||
|
|
||||||
## Overview
|
## Overview
|
||||||
|
|
||||||
@@ -34,13 +34,13 @@ Follow these commit message conventions based on 500 analyzed commits.
|
|||||||
### Prefixes Used
|
### Prefixes Used
|
||||||
|
|
||||||
- `fix`
|
- `fix`
|
||||||
- `test`
|
|
||||||
- `feat`
|
- `feat`
|
||||||
- `docs`
|
- `docs`
|
||||||
|
- `chore`
|
||||||
|
|
||||||
### Message Guidelines
|
### Message Guidelines
|
||||||
|
|
||||||
- Average message length: ~65 characters
|
- Average message length: ~57 characters
|
||||||
- Keep first line concise and descriptive
|
- Keep first line concise and descriptive
|
||||||
- Use imperative mood ("Add feature" not "Added feature")
|
- Use imperative mood ("Add feature" not "Added feature")
|
||||||
|
|
||||||
@@ -48,49 +48,49 @@ Follow these commit message conventions based on 500 analyzed commits.
|
|||||||
*Commit message example*
|
*Commit message example*
|
||||||
|
|
||||||
```text
|
```text
|
||||||
feat(rules): add C# language support
|
feat: add everything-claude-code ECC bundle (.claude/commands/add-or-update-command.md)
|
||||||
```
|
```
|
||||||
|
|
||||||
*Commit message example*
|
*Commit message example*
|
||||||
|
|
||||||
```text
|
```text
|
||||||
chore(deps-dev): bump flatted (#675)
|
fix: port safe ci cleanup from backlog
|
||||||
```
|
```
|
||||||
|
|
||||||
*Commit message example*
|
*Commit message example*
|
||||||
|
|
||||||
```text
|
```text
|
||||||
fix: auto-detect ECC root from plugin cache when CLAUDE_PLUGIN_ROOT is unset (#547) (#691)
|
refactor: collapse legacy command bodies into skills
|
||||||
```
|
```
|
||||||
|
|
||||||
*Commit message example*
|
*Commit message example*
|
||||||
|
|
||||||
```text
|
```text
|
||||||
docs: add Antigravity setup and usage guide (#552)
|
docs: close bundle drift and sync plugin guidance
|
||||||
```
|
```
|
||||||
|
|
||||||
*Commit message example*
|
*Commit message example*
|
||||||
|
|
||||||
```text
|
```text
|
||||||
merge: PR #529 — feat(skills): add documentation-lookup, bun-runtime, nextjs-turbopack; feat(agents): add rust-reviewer
|
chore: ignore local orchestration artifacts
|
||||||
```
|
```
|
||||||
|
|
||||||
*Commit message example*
|
*Commit message example*
|
||||||
|
|
||||||
```text
|
```text
|
||||||
Revert "Add Kiro IDE support (.kiro/) (#548)"
|
feat: add everything-claude-code ECC bundle (.claude/commands/add-or-update-skill.md)
|
||||||
```
|
```
|
||||||
|
|
||||||
*Commit message example*
|
*Commit message example*
|
||||||
|
|
||||||
```text
|
```text
|
||||||
Add Kiro IDE support (.kiro/) (#548)
|
feat: add everything-claude-code ECC bundle (.claude/commands/feature-development.md)
|
||||||
```
|
```
|
||||||
|
|
||||||
*Commit message example*
|
*Commit message example*
|
||||||
|
|
||||||
```text
|
```text
|
||||||
feat: add block-no-verify hook for Claude Code and Cursor (#649)
|
feat: add everything-claude-code ECC bundle (.claude/enterprise/controls.md)
|
||||||
```
|
```
|
||||||
|
|
||||||
## Architecture
|
## Architecture
|
||||||
@@ -184,33 +184,11 @@ try {
|
|||||||
|
|
||||||
These workflows were detected from analyzing commit patterns.
|
These workflows were detected from analyzing commit patterns.
|
||||||
|
|
||||||
### Database Migration
|
|
||||||
|
|
||||||
Database schema changes with migration files
|
|
||||||
|
|
||||||
**Frequency**: ~2 times per month
|
|
||||||
|
|
||||||
**Steps**:
|
|
||||||
1. Create migration file
|
|
||||||
2. Update schema definitions
|
|
||||||
3. Generate/update types
|
|
||||||
|
|
||||||
**Files typically involved**:
|
|
||||||
- `**/schema.*`
|
|
||||||
- `migrations/*`
|
|
||||||
|
|
||||||
**Example commit sequence**:
|
|
||||||
```
|
|
||||||
feat: implement --with/--without selective install flags (#679)
|
|
||||||
fix: sync catalog counts with filesystem (27 agents, 113 skills, 58 commands) (#693)
|
|
||||||
feat(rules): add Rust language rules (rebased #660) (#686)
|
|
||||||
```
|
|
||||||
|
|
||||||
### Feature Development
|
### Feature Development
|
||||||
|
|
||||||
Standard feature implementation workflow
|
Standard feature implementation workflow
|
||||||
|
|
||||||
**Frequency**: ~22 times per month
|
**Frequency**: ~19 times per month
|
||||||
|
|
||||||
**Steps**:
|
**Steps**:
|
||||||
1. Add feature implementation
|
1. Add feature implementation
|
||||||
@@ -218,205 +196,204 @@ Standard feature implementation workflow
|
|||||||
3. Update documentation
|
3. Update documentation
|
||||||
|
|
||||||
**Files typically involved**:
|
**Files typically involved**:
|
||||||
- `manifests/*`
|
- `.opencode/*`
|
||||||
- `schemas/*`
|
- `.opencode/plugins/*`
|
||||||
|
- `.opencode/plugins/lib/*`
|
||||||
- `**/*.test.*`
|
- `**/*.test.*`
|
||||||
- `**/api/**`
|
|
||||||
|
|
||||||
**Example commit sequence**:
|
**Example commit sequence**:
|
||||||
```
|
```
|
||||||
feat(skills): add documentation-lookup, bun-runtime, nextjs-turbopack; feat(agents): add rust-reviewer
|
feat: add GAN-style generator-evaluator harness (#1029)
|
||||||
docs(skills): align documentation-lookup with CONTRIBUTING template; add cross-harness (Codex/Cursor) skill copies
|
feat(agents,skills): add opensource-pipeline — 3-agent workflow for safe public releases (#1036)
|
||||||
fix: address PR review — skill template (When to use, How it works, Examples), bun.lock, next build note, rust-reviewer CI note, doc-lookup privacy/uncertainty
|
feat(install): add CodeBuddy(Tencent) adaptation with installation scripts (#1038)
|
||||||
```
|
```
|
||||||
|
|
||||||
### Add Language Rules
|
### Refactoring
|
||||||
|
|
||||||
Adds a new programming language to the rules system, including coding style, hooks, patterns, security, and testing guidelines.
|
Code refactoring and cleanup workflow
|
||||||
|
|
||||||
**Frequency**: ~2 times per month
|
**Frequency**: ~2 times per month
|
||||||
|
|
||||||
**Steps**:
|
**Steps**:
|
||||||
1. Create a new directory under rules/{language}/
|
1. Ensure tests pass before refactor
|
||||||
2. Add coding-style.md, hooks.md, patterns.md, security.md, and testing.md files with language-specific content
|
2. Refactor code structure
|
||||||
3. Optionally reference or link to related skills
|
3. Verify tests still pass
|
||||||
|
|
||||||
**Files typically involved**:
|
**Files typically involved**:
|
||||||
- `rules/*/coding-style.md`
|
- `src/**/*`
|
||||||
- `rules/*/hooks.md`
|
|
||||||
- `rules/*/patterns.md`
|
|
||||||
- `rules/*/security.md`
|
|
||||||
- `rules/*/testing.md`
|
|
||||||
|
|
||||||
**Example commit sequence**:
|
**Example commit sequence**:
|
||||||
```
|
```
|
||||||
Create a new directory under rules/{language}/
|
refactor: collapse legacy command bodies into skills
|
||||||
Add coding-style.md, hooks.md, patterns.md, security.md, and testing.md files with language-specific content
|
feat: add connected operator workflow skills
|
||||||
Optionally reference or link to related skills
|
feat: expand lead intelligence outreach channels
|
||||||
```
|
```
|
||||||
|
|
||||||
### Add New Skill
|
### Add Or Update Skill
|
||||||
|
|
||||||
Adds a new skill to the system, documenting its workflow, triggers, and usage, often with supporting scripts.
|
Adds a new skill or updates an existing skill, including documentation and configuration.
|
||||||
|
|
||||||
|
**Frequency**: ~6 times per month
|
||||||
|
|
||||||
|
**Steps**:
|
||||||
|
1. Create or update a SKILL.md file in the appropriate skills directory (e.g., skills/skill-name/SKILL.md or .agents/skills/skill-name/SKILL.md or .claude/skills/skill-name/SKILL.md).
|
||||||
|
2. Optionally update related manifests or documentation (e.g., AGENTS.md, README.md).
|
||||||
|
|
||||||
|
**Files typically involved**:
|
||||||
|
- `skills/*/SKILL.md`
|
||||||
|
- `.agents/skills/*/SKILL.md`
|
||||||
|
- `.claude/skills/*/SKILL.md`
|
||||||
|
|
||||||
|
**Example commit sequence**:
|
||||||
|
```
|
||||||
|
Create or update a SKILL.md file in the appropriate skills directory (e.g., skills/skill-name/SKILL.md or .agents/skills/skill-name/SKILL.md or .claude/skills/skill-name/SKILL.md).
|
||||||
|
Optionally update related manifests or documentation (e.g., AGENTS.md, README.md).
|
||||||
|
```
|
||||||
|
|
||||||
|
### Add Or Update Command
|
||||||
|
|
||||||
|
Adds a new workflow command or updates an existing command for agentic workflows.
|
||||||
|
|
||||||
**Frequency**: ~4 times per month
|
**Frequency**: ~4 times per month
|
||||||
|
|
||||||
**Steps**:
|
**Steps**:
|
||||||
1. Create a new directory under skills/{skill-name}/
|
1. Create or update a markdown file in the commands/ directory (e.g., commands/command-name.md).
|
||||||
2. Add SKILL.md with documentation (When to Use, How It Works, Examples, etc.)
|
2. Optionally update related documentation or reference files.
|
||||||
3. Optionally add scripts or supporting files under skills/{skill-name}/scripts/
|
|
||||||
4. Address review feedback and iterate on documentation
|
|
||||||
|
|
||||||
**Files typically involved**:
|
**Files typically involved**:
|
||||||
- `skills/*/SKILL.md`
|
- `commands/*.md`
|
||||||
- `skills/*/scripts/*.sh`
|
|
||||||
- `skills/*/scripts/*.js`
|
|
||||||
|
|
||||||
**Example commit sequence**:
|
**Example commit sequence**:
|
||||||
```
|
```
|
||||||
Create a new directory under skills/{skill-name}/
|
Create or update a markdown file in the commands/ directory (e.g., commands/command-name.md).
|
||||||
Add SKILL.md with documentation (When to Use, How It Works, Examples, etc.)
|
Optionally update related documentation or reference files.
|
||||||
Optionally add scripts or supporting files under skills/{skill-name}/scripts/
|
|
||||||
Address review feedback and iterate on documentation
|
|
||||||
```
|
```
|
||||||
|
|
||||||
### Add New Agent
|
### Add Skill And Agents Bundle
|
||||||
|
|
||||||
Adds a new agent to the system for code review, build resolution, or other automated tasks.
|
Adds a new feature or workflow by bundling new agents, skills, and supporting scripts or commands.
|
||||||
|
|
||||||
**Frequency**: ~2 times per month
|
|
||||||
|
|
||||||
**Steps**:
|
|
||||||
1. Create a new agent markdown file under agents/{agent-name}.md
|
|
||||||
2. Register the agent in AGENTS.md
|
|
||||||
3. Optionally update README.md and docs/COMMAND-AGENT-MAP.md
|
|
||||||
|
|
||||||
**Files typically involved**:
|
|
||||||
- `agents/*.md`
|
|
||||||
- `AGENTS.md`
|
|
||||||
- `README.md`
|
|
||||||
- `docs/COMMAND-AGENT-MAP.md`
|
|
||||||
|
|
||||||
**Example commit sequence**:
|
|
||||||
```
|
|
||||||
Create a new agent markdown file under agents/{agent-name}.md
|
|
||||||
Register the agent in AGENTS.md
|
|
||||||
Optionally update README.md and docs/COMMAND-AGENT-MAP.md
|
|
||||||
```
|
|
||||||
|
|
||||||
### Add New Workflow Surface
|
|
||||||
|
|
||||||
Adds or updates a workflow entrypoint. Default to skills-first; only add a command shim when legacy slash compatibility is still required.
|
|
||||||
|
|
||||||
**Frequency**: ~1 times per month
|
|
||||||
|
|
||||||
**Steps**:
|
|
||||||
1. Create or update the canonical workflow under skills/{skill-name}/SKILL.md
|
|
||||||
2. Only if needed, add or update commands/{command-name}.md as a compatibility shim
|
|
||||||
|
|
||||||
**Files typically involved**:
|
|
||||||
- `skills/*/SKILL.md`
|
|
||||||
- `commands/*.md` (only when a legacy shim is intentionally retained)
|
|
||||||
|
|
||||||
**Example commit sequence**:
|
|
||||||
```
|
|
||||||
Create or update the canonical skill under skills/{skill-name}/SKILL.md
|
|
||||||
Only if needed, add or update commands/{command-name}.md as a compatibility shim
|
|
||||||
```
|
|
||||||
|
|
||||||
### Sync Catalog Counts
|
|
||||||
|
|
||||||
Synchronizes the documented counts of agents, skills, and commands in AGENTS.md and README.md with the actual repository state.
|
|
||||||
|
|
||||||
**Frequency**: ~3 times per month
|
**Frequency**: ~3 times per month
|
||||||
|
|
||||||
**Steps**:
|
**Steps**:
|
||||||
1. Update agent, skill, and command counts in AGENTS.md
|
1. Create agent definition markdown files in agents/ (e.g., agents/agent-name.md).
|
||||||
2. Update the same counts in README.md (quick-start, comparison table, etc.)
|
2. Create a SKILL.md file in skills/ (e.g., skills/feature-name/SKILL.md).
|
||||||
3. Optionally update other documentation files
|
3. Optionally add supporting scripts or commands.
|
||||||
|
4. Update documentation or manifests as needed.
|
||||||
|
|
||||||
**Files typically involved**:
|
**Files typically involved**:
|
||||||
- `AGENTS.md`
|
- `agents/*.md`
|
||||||
- `README.md`
|
- `skills/*/SKILL.md`
|
||||||
|
- `scripts/*.sh`
|
||||||
|
- `commands/*.md`
|
||||||
|
|
||||||
**Example commit sequence**:
|
**Example commit sequence**:
|
||||||
```
|
```
|
||||||
Update agent, skill, and command counts in AGENTS.md
|
Create agent definition markdown files in agents/ (e.g., agents/agent-name.md).
|
||||||
Update the same counts in README.md (quick-start, comparison table, etc.)
|
Create a SKILL.md file in skills/ (e.g., skills/feature-name/SKILL.md).
|
||||||
Optionally update other documentation files
|
Optionally add supporting scripts or commands.
|
||||||
|
Update documentation or manifests as needed.
|
||||||
```
|
```
|
||||||
|
|
||||||
### Add Cross Harness Skill Copies
|
### Add Install Target
|
||||||
|
|
||||||
Adds skill copies for different agent harnesses (e.g., Codex, Cursor, Antigravity) to ensure compatibility across platforms.
|
Adds a new install target (integration with an external tool or platform) including scripts, schemas, and manifest updates.
|
||||||
|
|
||||||
**Frequency**: ~2 times per month
|
**Frequency**: ~2 times per month
|
||||||
|
|
||||||
**Steps**:
|
**Steps**:
|
||||||
1. Copy or adapt SKILL.md to .agents/skills/{skill}/SKILL.md and/or .cursor/skills/{skill}/SKILL.md
|
1. Add a new directory for the target (e.g., .codebuddy/, .gemini/), including README and install/uninstall scripts.
|
||||||
2. Optionally add harness-specific openai.yaml or config files
|
2. Update manifests/install-modules.json and schemas/ecc-install-config.schema.json.
|
||||||
3. Address review feedback to align with CONTRIBUTING template
|
3. Add or update scripts in scripts/lib/install-targets/.
|
||||||
|
4. Add or update tests for the new install target.
|
||||||
|
|
||||||
**Files typically involved**:
|
**Files typically involved**:
|
||||||
- `.agents/skills/*/SKILL.md`
|
- `.codebuddy/*`
|
||||||
- `.cursor/skills/*/SKILL.md`
|
- `.gemini/*`
|
||||||
- `.agents/skills/*/agents/openai.yaml`
|
- `manifests/install-modules.json`
|
||||||
|
- `schemas/ecc-install-config.schema.json`
|
||||||
|
- `schemas/install-modules.schema.json`
|
||||||
|
- `scripts/lib/install-targets/*.js`
|
||||||
|
- `tests/lib/install-targets.test.js`
|
||||||
|
|
||||||
**Example commit sequence**:
|
**Example commit sequence**:
|
||||||
```
|
```
|
||||||
Copy or adapt SKILL.md to .agents/skills/{skill}/SKILL.md and/or .cursor/skills/{skill}/SKILL.md
|
Add a new directory for the target (e.g., .codebuddy/, .gemini/), including README and install/uninstall scripts.
|
||||||
Optionally add harness-specific openai.yaml or config files
|
Update manifests/install-modules.json and schemas/ecc-install-config.schema.json.
|
||||||
Address review feedback to align with CONTRIBUTING template
|
Add or update scripts in scripts/lib/install-targets/.
|
||||||
|
Add or update tests for the new install target.
|
||||||
```
|
```
|
||||||
|
|
||||||
### Add Or Update Hook
|
### Sync Or Update Codex Ecc Baseline
|
||||||
|
|
||||||
Adds or updates git or bash hooks to enforce workflow, quality, or security policies.
|
Synchronizes or updates configuration and scripts between ECC and Codex, ensuring consistency across tools.
|
||||||
|
|
||||||
**Frequency**: ~1 times per month
|
**Frequency**: ~2 times per month
|
||||||
|
|
||||||
**Steps**:
|
**Steps**:
|
||||||
1. Add or update hook scripts in hooks/ or scripts/hooks/
|
1. Update or create scripts in scripts/codex/ and scripts/sync-ecc-to-codex.sh.
|
||||||
2. Register the hook in hooks/hooks.json or similar config
|
2. Update configuration files such as package.json and related test files.
|
||||||
3. Optionally add or update tests in tests/hooks/
|
3. Update documentation (e.g., WORKING-CONTEXT.md).
|
||||||
|
|
||||||
|
**Files typically involved**:
|
||||||
|
- `scripts/codex/*.js`
|
||||||
|
- `scripts/sync-ecc-to-codex.sh`
|
||||||
|
- `package.json`
|
||||||
|
- `tests/scripts/*.test.js`
|
||||||
|
- `WORKING-CONTEXT.md`
|
||||||
|
|
||||||
|
**Example commit sequence**:
|
||||||
|
```
|
||||||
|
Update or create scripts in scripts/codex/ and scripts/sync-ecc-to-codex.sh.
|
||||||
|
Update configuration files such as package.json and related test files.
|
||||||
|
Update documentation (e.g., WORKING-CONTEXT.md).
|
||||||
|
```
|
||||||
|
|
||||||
|
### Update Hooks And Hook Tests
|
||||||
|
|
||||||
|
Updates hook configuration and logic, often with corresponding test updates.
|
||||||
|
|
||||||
|
**Frequency**: ~3 times per month
|
||||||
|
|
||||||
|
**Steps**:
|
||||||
|
1. Update hooks/hooks.json and/or scripts/hooks/*.js.
|
||||||
|
2. Update or add related test files in tests/hooks/ or tests/scripts/.
|
||||||
|
3. Optionally update documentation (e.g., WORKING-CONTEXT.md).
|
||||||
|
|
||||||
**Files typically involved**:
|
**Files typically involved**:
|
||||||
- `hooks/*.hook`
|
|
||||||
- `hooks/hooks.json`
|
- `hooks/hooks.json`
|
||||||
- `scripts/hooks/*.js`
|
- `scripts/hooks/*.js`
|
||||||
- `tests/hooks/*.test.js`
|
- `tests/hooks/*.test.js`
|
||||||
- `.cursor/hooks.json`
|
- `tests/scripts/*.test.js`
|
||||||
|
- `WORKING-CONTEXT.md`
|
||||||
|
|
||||||
**Example commit sequence**:
|
**Example commit sequence**:
|
||||||
```
|
```
|
||||||
Add or update hook scripts in hooks/ or scripts/hooks/
|
Update hooks/hooks.json and/or scripts/hooks/*.js.
|
||||||
Register the hook in hooks/hooks.json or similar config
|
Update or add related test files in tests/hooks/ or tests/scripts/.
|
||||||
Optionally add or update tests in tests/hooks/
|
Optionally update documentation (e.g., WORKING-CONTEXT.md).
|
||||||
```
|
```
|
||||||
|
|
||||||
### Address Review Feedback
|
### Update Or Add Documentation
|
||||||
|
|
||||||
Addresses code review feedback by updating documentation, scripts, or configuration for clarity, correctness, or convention alignment.
|
Adds or updates documentation files, including troubleshooting, guides, and context files.
|
||||||
|
|
||||||
**Frequency**: ~4 times per month
|
**Frequency**: ~4 times per month
|
||||||
|
|
||||||
**Steps**:
|
**Steps**:
|
||||||
1. Edit SKILL.md, agent, or command files to address reviewer comments
|
1. Create or update markdown files in docs/ or root directory.
|
||||||
2. Update examples, headings, or configuration as requested
|
2. Optionally update related context files (e.g., WORKING-CONTEXT.md).
|
||||||
3. Iterate until all review feedback is resolved
|
|
||||||
|
|
||||||
**Files typically involved**:
|
**Files typically involved**:
|
||||||
- `skills/*/SKILL.md`
|
- `docs/*.md`
|
||||||
- `agents/*.md`
|
- `WORKING-CONTEXT.md`
|
||||||
- `commands/*.md`
|
- `README.md`
|
||||||
- `.agents/skills/*/SKILL.md`
|
- `README.zh-CN.md`
|
||||||
- `.cursor/skills/*/SKILL.md`
|
|
||||||
|
|
||||||
**Example commit sequence**:
|
**Example commit sequence**:
|
||||||
```
|
```
|
||||||
Edit SKILL.md, agent, or command files to address reviewer comments
|
Create or update markdown files in docs/ or root directory.
|
||||||
Update examples, headings, or configuration as requested
|
Optionally update related context files (e.g., WORKING-CONTEXT.md).
|
||||||
Iterate until all review feedback is resolved
|
|
||||||
```
|
```
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
Reference in New Issue
Block a user