mirror of
https://github.com/affaan-m/everything-claude-code.git
synced 2026-04-14 22:13:41 +08:00
5.8 KiB
5.8 KiB
# everything-claude-code Development Patterns
> Auto-generated skill from repository analysis
## Overview
This skill teaches you the core development patterns, coding conventions, and collaborative workflows used in the `everything-claude-code` JavaScript repository. You'll learn how to add or update skills, agents, commands, install targets, and documentation, as well as how to maintain code quality and consistency across the project. The guide is based on real repository analysis and is designed to help contributors onboard quickly and work effectively.
---
## Coding Conventions
**File Naming**
- Use `camelCase` for JavaScript files and directories.
- Example: `installManifests.js`, `installTargets/registry.js`
**Import Style**
- Use relative imports for modules within the project.
```js
// Example
const registry = require('./registry');
Export Style
- Mixed: both CommonJS (
module.exports) and ES6 (export) styles may be present.// CommonJS module.exports = function install() { ... }; // ES6 (if present) export function install() { ... }
Commit Messages
- Use Conventional Commits with prefixes:
fix,feat,docs,chore
- Keep commit messages concise (average ~56 characters).
- Example:
feat: add support for new install target
- Example:
Workflows
Add or Update Skill
Trigger: When introducing or updating a skill for agents
Command: /add-skill
- Create or update
SKILL.mdinskills/<skill-name>/ - Optionally add or update related agent or command files
- Update
manifests/install-modules.jsonto register the skill - Update
AGENTS.mdand/orREADME.mdto reflect the new skill - If documentation is multilingual, update
docs/zh-CN/andREADME.zh-CN.md
Example:
# Add a new skill
mkdir -p skills/myNewSkill
nano skills/myNewSkill/SKILL.md
# Register the skill
nano manifests/install-modules.json
# Update documentation
nano AGENTS.md
nano README.md
Add or Update Agent
Trigger: When introducing or updating an agent definition
Command: /add-agent
- Create or update agent definition in
agents/<agent-name>.mdor.opencode/prompts/agents/ - Update
.opencode/opencode.jsonor similar registry/config - Update
AGENTS.mdto reflect new/changed agents - Optionally update orchestration or skills that reference the agent
Add or Update Command
Trigger: When introducing or improving a workflow command
Command: /add-command
- Create or update command markdown file in
commands/<command-name>.md - If related, update
AGENTS.mdorREADME.mdto document the new command - If command is part of a workflow, update or add related agent/skill files
Add New Install Target or Adapter
Trigger: When supporting a new install environment or integration
Command: /add-install-target
- Create new install scripts and documentation under a dedicated directory (e.g.,
.codebuddy/,.gemini/) - Add or update install target file in
scripts/lib/install-targets/ - Update
manifests/install-modules.jsonandschemas/*.schema.jsonas needed - Update
scripts/lib/install-manifests.jsandscripts/lib/install-targets/registry.js - Add or update related tests in
tests/lib/install-targets.test.js
Dependency Update via Dependabot
Trigger: When Dependabot detects an outdated dependency
Command: /update-dependency
- Update dependency version in
package.json,yarn.lock, or workflow YAML - Regenerate lockfiles if needed
- Commit with a standardized message referencing dependency and version
- Optionally update
.github/dependabot.yml
Hook or CI Script Refactor or Fix
Trigger: When fixing, optimizing, or refactoring hooks or CI scripts
Command: /fix-hook
- Edit
hooks/hooks.jsonand/orscripts/hooks/*.jsor shell scripts - Update or add related test files in
tests/hooks/ortests/scripts/ - If needed, update configuration or schema files
- Optionally update documentation (
WORKING-CONTEXT.md,README.md)
Documentation Update or Sync
Trigger: When updating, clarifying, or synchronizing documentation
Command: /update-docs
- Edit or add markdown files in
docs/,AGENTS.md,README.md,WORKING-CONTEXT.md, etc. - If multilingual, update
docs/zh-CN/andREADME.zh-CN.md - Optionally update related skill or agent documentation
Testing Patterns
- Test Files: Use the pattern
*.test.jsfor test files. - Framework: No specific testing framework detected; use standard Node.js or your preferred test runner.
- Location: Tests are typically placed alongside the code they test or in
tests/subdirectories. - Example:
// tests/lib/install-targets.test.js const assert = require('assert'); const installTarget = require('../../scripts/lib/install-targets/myTarget'); describe('installTarget', () => { it('should install correctly', () => { assert(installTarget.install()); }); });
Commands
| Command | Purpose |
|---|---|
| /add-skill | Add or update a skill and register it with documentation |
| /add-agent | Add or update an agent definition and registry |
| /add-command | Add or update a workflow command for agents |
| /add-install-target | Add support for a new install target or integration |
| /update-dependency | Update dependencies via Dependabot or manually |
| /fix-hook | Refactor or fix hooks and CI scripts |
| /update-docs | Update or synchronize documentation in one or more languages |