mirror of
https://github.com/affaan-m/everything-claude-code.git
synced 2026-04-14 05:43:29 +08:00
5.8 KiB
5.8 KiB
# everything-claude-code Development Patterns
> Auto-generated skill from repository analysis
## Overview
This skill documents the core development patterns, coding conventions, and agentic workflows used in the `everything-claude-code` (ECC) repository. The project is written in JavaScript (no framework detected) and implements modular, agent-driven automation and installable skills. This guide covers how to contribute new skills, commands, install targets, agent definitions, and more, following the repository's conventions and workflows.
## Coding Conventions
ECC follows consistent JavaScript coding and repository organization conventions:
### File Naming
- Use **camelCase** for JavaScript files and modules.
- Example: `myModule.js`, `installTarget.js`
### Import Style
- Use **relative imports** for internal modules.
```js
// Good
const utils = require('./utils');
import { doThing } from '../lib/doThing.js';
Export Style
- Both CommonJS and ES module exports are used, depending on context.
// CommonJS module.exports = function doSomething() { ... }; // ES Module export function doSomethingElse() { ... }
Commit Messages
- Prefix with
fix:,feat:,docs:, orchore: - Keep messages concise (average ~56 characters)
feat: add support for new install target fix: resolve agent prompt parsing bug
Workflows
Add or Update a Skill
Trigger: When introducing or updating a skill for agentic workflows
Command: /add-skill
- Create or update a
SKILL.mdfile underskills/{skill-name}/or.agents/skills/{skill-name}/. - Optionally update
AGENTS.md,README.md, and localized docs (e.g.,README.zh-CN.md). - Update
manifests/install-modules.jsonand/orinstall-components.jsonif the skill is installable. - Optionally add or update related agent markdown files.
- Optionally update tests or scripts if the skill introduces new hooks or behaviors.
Example:
mkdir -p skills/myNewSkill
touch skills/myNewSkill/SKILL.md
# Edit SKILL.md with documentation
Add or Update a Command Workflow
Trigger: When adding or updating a repeatable workflow command
Command: /add-command
- Create or update a markdown file in
commands/(e.g.,prp-*.md,gan-*.md,santa-loop.md). - Document workflow phases, usage, and outputs in the file.
- Optionally update related skills or agent definitions.
- Optionally add shell scripts or orchestrators if automation is needed.
- Optionally update
AGENTS.mdorREADME.mdto reference the new command.
Example:
touch commands/prp-myworkflow.md
# Document the workflow steps in markdown
Add or Update an Install Target
Trigger: When supporting a new IDE/platform or updating install logic
Command: /add-install-target
- Add or update install scripts (
install.sh,install.js,uninstall.sh,uninstall.js) in a new or existing directory (e.g.,.codebuddy/). - Update
manifests/install-modules.jsonandschemas/ecc-install-config.schema.json. - Update
scripts/lib/install-manifests.jsandscripts/lib/install-targets/{target}.js. - Add or update tests for install targets.
- Optionally update
README.mdorAGENTS.md.
Example:
mkdir -p .codebuddy
touch .codebuddy/install.sh
# Implement install logic
Update Hooks and Hook Tests
Trigger: When refactoring, fixing, or extending system hooks
Command: /update-hook
- Edit
hooks/hooks.jsonto change configuration or add/remove hooks. - Edit or add
scripts/hooks/*.jsto implement hook logic. - Edit or add
tests/hooks/*.test.jsto cover new or changed behaviors. - Optionally update related scripts or documentation.
Example:
// hooks/hooks.json
{
"pre-commit": ["format", "typecheck"]
}
Dependency Bump via Dependabot
Trigger: When updating dependencies for security or features
Command: /bump-dependency
- Update dependency version in
package.json,yarn.lock, or workflow YAML files. - Commit with a standardized message (often by dependabot).
- Optionally update related documentation or changelogs.
Example:
// package.json
"dependencies": {
"some-lib": "^2.0.0"
}
Add or Update Agent Definition
Trigger: When adding or modifying agent definitions/prompts
Command: /add-agent
- Add or update agent markdown files (
agents/*.md). - Add or update prompt files (
.opencode/prompts/agents/*.txt). - Update
.opencode/opencode.jsonto register new agents. - Update
AGENTS.mdto document new agents. - Optionally update related skills or orchestrators.
Example:
touch agents/myAgent.md
touch .opencode/prompts/agents/myAgent.txt
Testing Patterns
- Test files follow the pattern
*.test.js. - Testing framework is unknown (not detected), but test files are placed alongside code or in
tests/directories. - Example test file:
// tests/hooks/formatHook.test.js const formatHook = require('../../scripts/hooks/formatHook'); test('should format code correctly', () => { // test implementation });
Commands
| Command | Purpose |
|---|---|
| /add-skill | Add or update a skill and its documentation |
| /add-command | Add or update a workflow command |
| /add-install-target | Add or update an install target (IDE/platform/environment) |
| /update-hook | Refactor, fix, or extend system hooks and their tests |
| /bump-dependency | Update dependency versions in package or workflow files |
| /add-agent | Add or update agent definitions and prompts |