11 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-design-review — three-tier design doc review
Commit message example
fix(tests): add USERPROFILE to repair.test.js for Windows
Commit message example
refactor: collapse legacy command bodies into skills
Commit message example
docs: close bundle drift and sync plugin guidance
Commit message example
chore: ignore local orchestration artifacts
Commit message example
fix(lint): add missing trailing newlines to remotion rules
Commit message example
fix(tests): normalize path separators in CLAUDE_PLUGIN_ROOT test
Commit message example
fix(ci): resolve markdownlint errors and Windows install-apply test
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: ~16 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: ~2 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 skill to the system, including documentation and registration in summary/index files.
Frequency: ~6 times per month
Steps:
- Create a new SKILL.md file under skills/{skill-name}/
- Optionally add reference files or assets under skills/{skill-name}/references/ or assets/
- Update AGENTS.md and README.md to document the new skill
- Update docs/zh-CN/AGENTS.md and docs/zh-CN/README.md for Chinese documentation
- Optionally update manifests/install-components.json or install-modules.json if the skill is installable
Files typically involved:
skills/*/SKILL.mdskills/*/references/*.mdskills/*/assets/*AGENTS.mdREADME.mdREADME.zh-CN.mddocs/zh-CN/AGENTS.mddocs/zh-CN/README.mdmanifests/install-components.jsonmanifests/install-modules.json
Example commit sequence:
Create a new SKILL.md file under skills/{skill-name}/
Optionally add reference files or assets under skills/{skill-name}/references/ or assets/
Update AGENTS.md and README.md to document the new skill
Update docs/zh-CN/AGENTS.md and docs/zh-CN/README.md for Chinese documentation
Optionally update manifests/install-components.json or install-modules.json if the skill is installable
Add Or Update Command Workflow
Adds or updates a command file describing a workflow, often for agent orchestration or developer automation.
Frequency: ~3 times per month
Steps:
- Create or modify a Markdown file under commands/ (e.g., commands/prp-.md, commands/gan-.md, commands/santa-loop.md)
- Document the workflow with YAML frontmatter, usage, and output sections
- Optionally update AGENTS.md, README.md, or other summary files if the command is significant
- Address review feedback and iterate on the command file
Files typically involved:
commands/*.mdAGENTS.mdREADME.md
Example commit sequence:
Create or modify a Markdown file under commands/ (e.g., commands/prp-*.md, commands/gan-*.md, commands/santa-loop.md)
Document the workflow with YAML frontmatter, usage, and output sections
Optionally update AGENTS.md, README.md, or other summary files if the command is significant
Address review feedback and iterate on the command file
Add Or Update Agent Definition
Adds or updates agent definition files to introduce or modify agent behaviors or roles.
Frequency: ~2 times per month
Steps:
- Create or modify agent definition Markdown files under agents/
- Optionally update AGENTS.md to reflect new or changed agents
- Update skills or commands that reference the agent if necessary
Files typically involved:
agents/*.mdAGENTS.md
Example commit sequence:
Create or modify agent definition Markdown files under agents/
Optionally update AGENTS.md to reflect new or changed agents
Update skills or commands that reference the agent if necessary
Add Install Target Or Adapter
Adds a new install target (integration with external tools/platforms) including schema, scripts, and tests.
Frequency: ~2 times per month
Steps:
- Create a new directory under .{target}/ with README and install/uninstall scripts
- Add or update scripts/lib/install-targets/{target}-project.js
- Update manifests/install-modules.json and schemas/ecc-install-config.schema.json
- Update registry.js and install-manifests.js as needed
- Add or update tests for the new install target
Files typically involved:
.*/README.md.*/install.*.*/uninstall.*scripts/lib/install-targets/*.jsmanifests/install-modules.jsonschemas/ecc-install-config.schema.jsonschemas/install-modules.schema.jsonscripts/lib/install-manifests.jsscripts/lib/install-targets/registry.jstests/lib/install-targets.test.js
Example commit sequence:
Create a new directory under .{target}/ with README and install/uninstall scripts
Add or update scripts/lib/install-targets/{target}-project.js
Update manifests/install-modules.json and schemas/ecc-install-config.schema.json
Update registry.js and install-manifests.js as needed
Add or update tests for the new install target
Test Fix Or Portability Fix
Fixes or improves test scripts, especially for cross-platform (Windows/Linux) compatibility.
Frequency: ~3 times per month
Steps:
- Edit test files under tests/scripts/ or tests/lib/
- Normalize environment variables or path separators for Windows compatibility
- Update related implementation files if needed (e.g., scripts/lib/install/apply.js)
- Commit with a fix(tests): or fix(ci): message
Files typically involved:
tests/scripts/*.test.jstests/lib/*.test.jsscripts/lib/install/*.jsscripts/lib/install-manifests.js
Example commit sequence:
Edit test files under tests/scripts/ or tests/lib/
Normalize environment variables or path separators for Windows compatibility
Update related implementation files if needed (e.g., scripts/lib/install/apply.js)
Commit with a fix(tests): or fix(ci): message
Update Repo Documentation And Guidance
Updates documentation files to reflect new workflows, skills, or repo guidance.
Frequency: ~4 times per month
Steps:
- Edit README.md, README.zh-CN.md, WORKING-CONTEXT.md, AGENTS.md, or the-shortform-guide.md
- Edit docs/zh-CN/* as needed for Chinese documentation
- Optionally update .claude-plugin/README.md, .codex-plugin/README.md, or related plugin docs
Files typically involved:
README.mdREADME.zh-CN.mdWORKING-CONTEXT.mdAGENTS.mdthe-shortform-guide.mddocs/zh-CN/*.md.claude-plugin/README.md.codex-plugin/README.md
Example commit sequence:
Edit README.md, README.zh-CN.md, WORKING-CONTEXT.md, AGENTS.md, or the-shortform-guide.md
Edit docs/zh-CN/* as needed for Chinese documentation
Optionally update .claude-plugin/README.md, .codex-plugin/README.md, or related plugin docs
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.