8.3 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-03-24
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
fixfeatdocstest
Message Guidelines
- Average message length: ~62 characters
- Keep first line concise and descriptive
- Use imperative mood ("Add feature" not "Added feature")
Commit message example
feat: add everything-claude-code ECC bundle (.claude/commands/add-or-update-skill-documentation.md)
Commit message example
perf(hooks): move post-edit-format and post-edit-typecheck to strict-only (#757)
Commit message example
fix: safe Codex config sync — merge AGENTS.md + add-only MCP servers (#723)
Commit message example
docs(zh-CN): translate code block(plain text) (#753)
Commit message example
security: remove supply chain risks, external promotions, and unauthorized credits
Commit message example
feat: add everything-claude-code ECC bundle (.claude/commands/feature-development.md)
Commit message example
feat: add everything-claude-code ECC bundle (.claude/commands/database-migration.md)
Commit message example
feat: add everything-claude-code ECC bundle (.claude/enterprise/controls.md)
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.
Database Migration
Database schema changes with migration files
Frequency: ~2 times per month
Steps:
- Create migration file
- Update schema definitions
- Generate/update types
Files typically involved:
migrations/*
Example commit sequence:
Add Turkish (tr) docs and update README (#744)
docs(zh-CN): translate code block(plain text) (#753)
fix(install): add rust, cpp, csharp to legacy language alias map (#747)
Feature Development
Standard feature implementation workflow
Frequency: ~21 times per month
Steps:
- Add feature implementation
- Add tests for feature
- Update documentation
Files typically involved:
manifests/***/*.test.***/api/**
Example commit sequence:
docs(pt-BR): add rules translation
docs(pt-BR): add examples translation
docs(pt-BR): add commands translation
Add Or Update Skill
Adds a new skill or updates documentation for an existing skill.
Frequency: ~2 times per month
Steps:
- Create or update SKILL.md in the relevant skills directory.
- Optionally add architecture diagrams, implementation notes, or integration guidance.
Files typically involved:
skills/*/SKILL.mddocs/zh-CN/skills/*/SKILL.mddocs/tr/skills/*/SKILL.md
Example commit sequence:
Create or update SKILL.md in the relevant skills directory.
Optionally add architecture diagrams, implementation notes, or integration guidance.
Add Or Update Localization
Adds or updates documentation translations for a new or existing language.
Frequency: ~2 times per month
Steps:
- Add or update docs in docs// for agents, commands, skills, rules, and examples.
- Update README.md to reference the new or updated language.
- Optionally increment language count in README.
Files typically involved:
docs/zh-CN/**/*docs/pt-BR/**/*docs/tr/**/*README.md
Example commit sequence:
Add or update docs in docs/<lang>/ for agents, commands, skills, rules, and examples.
Update README.md to reference the new or updated language.
Optionally increment language count in README.
Add Or Update Command Doc
Adds or updates documentation for a CLI command.
Frequency: ~2 times per month
Steps:
- Create or update a markdown file in commands/ or docs//commands/.
- Optionally update README.md or AGENTS.md to reflect the new/updated command.
Files typically involved:
commands/*.mddocs/zh-CN/commands/*.mddocs/pt-BR/commands/*.mddocs/tr/commands/*.mdREADME.mdAGENTS.md
Example commit sequence:
Create or update a markdown file in commands/ or docs/<lang>/commands/.
Optionally update README.md or AGENTS.md to reflect the new/updated command.
Feature Development With Tests And Docs
Implements a new feature, adds or updates tests, and documents the change.
Frequency: ~2 times per month
Steps:
- Implement or modify feature code (e.g., in src/, scripts/, or main code directories).
- Update or add relevant tests in tests/.
- Update or add documentation in docs/ or README.md.
Files typically involved:
src/**/*scripts/**/*tests/**/*docs/**/*README.md
Example commit sequence:
Implement or modify feature code (e.g., in src/, scripts/, or main code directories).
Update or add relevant tests in tests/.
Update or add documentation in docs/ or README.md.
Add Or Update Hook
Adds or modifies a project hook for linting, formatting, or config protection.
Frequency: ~2 times per month
Steps:
- Edit or add hook configuration in hooks/hooks.json.
- Implement or update hook logic in scripts/hooks/.
- Optionally update related plugin files.
Files typically involved:
hooks/hooks.jsonscripts/hooks/*.js.opencode/plugins/*.ts
Example commit sequence:
Edit or add hook configuration in hooks/hooks.json.
Implement or update hook logic in scripts/hooks/.
Optionally update related plugin files.
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.