12 KiB
name, description
| name | description |
|---|---|
| everything-claude-code-conventions | Development conventions and patterns for everything-claude-code. JavaScript project with conventional commits. |
Everything Claude Code Conventions
Generated from affaan-m/everything-claude-code on 2026-04-02
Overview
This skill teaches Claude the development patterns and conventions used in everything-claude-code.
Tech Stack
- Primary Language: JavaScript
- Architecture: hybrid module organization
- Test Location: separate
When to Use This Skill
Activate this skill when:
- Making changes to this repository
- Adding new features following established patterns
- Writing tests that match project conventions
- Creating commits with proper message format
Commit Conventions
Follow these commit message conventions based on 500 analyzed commits.
Commit Style: Conventional Commits
Prefixes Used
fixfeatdocschore
Message Guidelines
- Average message length: ~56 characters
- Keep first line concise and descriptive
- Use imperative mood ("Add feature" not "Added feature")
Commit message example
feat(skills): add argus-dispatch — multi-model task dispatcher
Commit message example
refactor: extract social graph ranking core
Commit message example
fix: port safe ci cleanup from backlog
Commit message example
docs: close bundle drift and sync plugin guidance
Commit message example
chore: ignore local orchestration artifacts
Commit message example
feat(skills): add brand voice and network ops lanes
Commit message example
feat: sync the codex baseline and agent roles
Commit message example
fix: harden install and codex sync portability
Architecture
Project Structure: Single Package
This project uses hybrid module organization.
Configuration Files
.github/workflows/ci.yml.github/workflows/maintenance.yml.github/workflows/monthly-metrics.yml.github/workflows/release.yml.github/workflows/reusable-release.yml.github/workflows/reusable-test.yml.github/workflows/reusable-validate.yml.opencode/package.json.opencode/tsconfig.json.prettierrceslint.config.jspackage.json
Guidelines
- This project uses a hybrid organization
- Follow existing patterns when adding new code
Code Style
Language: JavaScript
Naming Conventions
| Element | Convention |
|---|---|
| Files | camelCase |
| Functions | camelCase |
| Classes | PascalCase |
| Constants | SCREAMING_SNAKE_CASE |
Import Style: Relative Imports
Export Style: Mixed Style
Preferred import style
// Use relative imports
import { Button } from '../components/Button'
import { useAuth } from './hooks/useAuth'
Testing
Test Framework
No specific test framework detected — use the repository's existing test patterns.
File Pattern: *.test.js
Test Types
- Unit tests: Test individual functions and components in isolation
- Integration tests: Test interactions between multiple components/services
Coverage
This project has coverage reporting configured. Aim for 80%+ coverage.
Error Handling
Error Handling Style: Try-Catch Blocks
Standard error handling pattern
try {
const result = await riskyOperation()
return result
} catch (error) {
console.error('Operation failed:', error)
throw new Error('User-friendly message')
}
Common Workflows
These workflows were detected from analyzing commit patterns.
Feature Development
Standard feature implementation workflow
Frequency: ~14 times per month
Steps:
- Add feature implementation
- Add tests for feature
- Update documentation
Files typically involved:
.opencode/*.opencode/plugins/*.opencode/plugins/lib/***/*.test.***/api/**
Example commit sequence:
feat(team-builder): use `claude agents` command for agent discovery (#1021)
fix: extract inline SessionStart bootstrap to separate file (#1035)
feat: add hexagonal architecture SKILL. (#1034)
Refactoring
Code refactoring and cleanup workflow
Frequency: ~3 times per month
Steps:
- Ensure tests pass before refactor
- Refactor code structure
- Verify tests still pass
Files typically involved:
src/**/*
Example commit sequence:
refactor: collapse legacy command bodies into skills
feat: add connected operator workflow skills
feat: expand lead intelligence outreach channels
Add New Skill
Adds a new AI agent skill to the codebase, including documentation and registration.
Frequency: ~3 times per month
Steps:
- Create a new SKILL.md file in skills// or .agents/skills//
- Optionally add supporting scripts or references under the skill directory
- Update AGENTS.md and/or README.md to document the new skill
- Update docs/zh-CN/AGENTS.md and docs/zh-CN/README.md for Chinese documentation
- Update manifests/install-modules.json or install-components.json to register the skill
Files typically involved:
skills/*/SKILL.md.agents/skills/*/SKILL.mdAGENTS.mdREADME.mdREADME.zh-CN.mddocs/zh-CN/AGENTS.mddocs/zh-CN/README.mdmanifests/install-modules.jsonmanifests/install-components.json
Example commit sequence:
Create a new SKILL.md file in skills/<skill-name>/ or .agents/skills/<skill-name>/
Optionally add supporting scripts or references under the skill directory
Update AGENTS.md and/or README.md to document the new skill
Update docs/zh-CN/AGENTS.md and docs/zh-CN/README.md for Chinese documentation
Update manifests/install-modules.json or install-components.json to register the skill
Add New Agent Or Pipeline
Adds a new agent or multi-agent workflow pipeline, including agent definitions and orchestration skills.
Frequency: ~2 times per month
Steps:
- Create one or more agent definition files in agents/
- Create or update a SKILL.md in skills// to orchestrate or document the workflow
- Optionally add supporting commands, scripts, or examples
- Update AGENTS.md and/or README.md to document the new pipeline
Files typically involved:
agents/*.mdskills/*/SKILL.mdcommands/*.mdscripts/*.shexamples/*/README.mdAGENTS.mdREADME.md
Example commit sequence:
Create one or more agent definition files in agents/
Create or update a SKILL.md in skills/<pipeline-name>/ to orchestrate or document the workflow
Optionally add supporting commands, scripts, or examples
Update AGENTS.md and/or README.md to document the new pipeline
Add Or Update Command Workflow
Adds or extends a CLI command for agent workflows, often with review feedback iterations.
Frequency: ~2 times per month
Steps:
- Create or update one or more command markdown files in commands/
- Iterate with fixes based on review feedback (improving YAML frontmatter, usage, output, etc.)
- Optionally update AGENTS.md or documentation to reference the new command
Files typically involved:
commands/*.mdAGENTS.mdREADME.md
Example commit sequence:
Create or update one or more command markdown files in commands/
Iterate with fixes based on review feedback (improving YAML frontmatter, usage, output, etc.)
Optionally update AGENTS.md or documentation to reference the new command
Add Install Target Or Adapter
Adds support for a new install target (e.g., Gemini, CodeBuddy), including scripts, schemas, and manifest updates.
Frequency: ~2 times per month
Steps:
- Add a new directory for the install target (e.g., .gemini/, .codebuddy/)
- Add install/uninstall scripts and README(s)
- Update schemas/ecc-install-config.schema.json and/or install-modules.schema.json
- Update manifests/install-modules.json
- Update scripts/lib/install-manifests.js and scripts/lib/install-targets/.js
- Add or update tests for the new install target
Files typically involved:
.<target>/*schemas/ecc-install-config.schema.jsonschemas/install-modules.schema.jsonmanifests/install-modules.jsonscripts/lib/install-manifests.jsscripts/lib/install-targets/*.jstests/lib/install-targets.test.js
Example commit sequence:
Add a new directory for the install target (e.g., .gemini/, .codebuddy/)
Add install/uninstall scripts and README(s)
Update schemas/ecc-install-config.schema.json and/or install-modules.schema.json
Update manifests/install-modules.json
Update scripts/lib/install-manifests.js and scripts/lib/install-targets/<target>.js
Add or update tests for the new install target
Update Hooks Or Automation
Refactors or fixes hooks and automation scripts for CI, formatting, or agent workflow integration.
Frequency: ~3 times per month
Steps:
- Edit hooks/hooks.json to update hook configuration
- Edit or add scripts/hooks/.js or scripts/hooks/.sh for hook logic
- Update or add tests for the hooks in tests/hooks/*.test.js
- Optionally update related scripts or documentation
Files typically involved:
hooks/hooks.jsonscripts/hooks/*.jsscripts/hooks/*.shtests/hooks/*.test.js
Example commit sequence:
Edit hooks/hooks.json to update hook configuration
Edit or add scripts/hooks/*.js or scripts/hooks/*.sh for hook logic
Update or add tests for the hooks in tests/hooks/*.test.js
Optionally update related scripts or documentation
Documentation Sync And Localization
Updates documentation and ensures Chinese and English docs are in sync, including AGENTS.md and README files.
Frequency: ~3 times per month
Steps:
- Edit AGENTS.md, README.md, README.zh-CN.md
- Edit docs/zh-CN/AGENTS.md, docs/zh-CN/README.md
- Optionally update skills//SKILL.md and .agents/skills//SKILL.md for doc improvements
- Edit WORKING-CONTEXT.md or the-shortform-guide.md as needed
Files typically involved:
AGENTS.mdREADME.mdREADME.zh-CN.mddocs/zh-CN/AGENTS.mddocs/zh-CN/README.mdskills/*/SKILL.md.agents/skills/*/SKILL.mdWORKING-CONTEXT.mdthe-shortform-guide.md
Example commit sequence:
Edit AGENTS.md, README.md, README.zh-CN.md
Edit docs/zh-CN/AGENTS.md, docs/zh-CN/README.md
Optionally update skills/*/SKILL.md and .agents/skills/*/SKILL.md for doc improvements
Edit WORKING-CONTEXT.md or the-shortform-guide.md as needed
Dependency Or Ci Update
Updates dependencies or CI workflow files, often via automated bots like dependabot.
Frequency: ~4 times per month
Steps:
- Edit .github/workflows/*.yml to update actions or workflow steps
- Edit package.json, yarn.lock, or package-lock.json for dependency updates
- Optionally update related scripts or lockfiles
Files typically involved:
.github/workflows/*.ymlpackage.jsonyarn.lockpackage-lock.json
Example commit sequence:
Edit .github/workflows/*.yml to update actions or workflow steps
Edit package.json, yarn.lock, or package-lock.json for dependency updates
Optionally update related scripts or lockfiles
Best Practices
Based on analysis of the codebase, follow these practices:
Do
- Use conventional commit format (feat:, fix:, etc.)
- Follow *.test.js naming pattern
- Use camelCase for file names
- Prefer mixed exports
Don't
- Don't write vague commit messages
- Don't skip tests for new features
- Don't deviate from established patterns without discussion
This skill was auto-generated by ECC Tools. Review and customize as needed for your team.