mirror of
https://github.com/affaan-m/everything-claude-code.git
synced 2026-04-02 07:03:28 +08:00
Compare commits
15 Commits
ecc-tools/
...
ecc-tools/
| Author | SHA1 | Date | |
|---|---|---|---|
|
a23988866c | ||
|
|
4abc4e8887 | ||
|
|
dc1c46d453 | ||
|
|
7b1bc6d407 | ||
|
|
c89b166538 | ||
|
|
67ea3c5437 | ||
|
|
efd4b37555 | ||
|
|
5fdc208620 | ||
|
|
02ce835abb | ||
|
|
e81df5da4c | ||
|
|
1833739141 | ||
|
|
102d3196c7 | ||
|
|
8bfd408622 | ||
|
|
d67e19e830 | ||
|
|
483aa8530f |
@@ -1,409 +1,166 @@
|
||||
---
|
||||
name: everything-claude-code-conventions
|
||||
description: Development conventions and patterns for everything-claude-code. JavaScript project with conventional commits.
|
||||
---
|
||||
```markdown
|
||||
# everything-claude-code Development Patterns
|
||||
|
||||
# Everything Claude Code Conventions
|
||||
|
||||
> Generated from [affaan-m/everything-claude-code](https://github.com/affaan-m/everything-claude-code) on 2026-04-01
|
||||
> Auto-generated skill from repository analysis
|
||||
|
||||
## Overview
|
||||
|
||||
This skill teaches Claude the development patterns and conventions used in everything-claude-code.
|
||||
This skill introduces the core development patterns, coding conventions, and common workflows for contributing to the `everything-claude-code` repository. The project is JavaScript-based, with no framework dependencies, and emphasizes modularity, agentic skills, and workflow automation. This guide covers file organization, commit conventions, code style, workflow steps, and testing patterns to help you contribute effectively and consistently.
|
||||
|
||||
## Tech Stack
|
||||
## Coding Conventions
|
||||
|
||||
- **Primary Language**: JavaScript
|
||||
- **Architecture**: hybrid module organization
|
||||
- **Test Location**: separate
|
||||
- **File Naming:** Use camelCase for JavaScript files and folders.
|
||||
- Example: `mySkill.js`, `installTarget.js`
|
||||
- **Import Style:** Use relative imports.
|
||||
- Example:
|
||||
```js
|
||||
const helper = require('./utils/helper');
|
||||
```
|
||||
- **Export Style:** Mixed (both CommonJS and ES module styles may be present).
|
||||
- Example (CommonJS):
|
||||
```js
|
||||
module.exports = function mySkill() { ... };
|
||||
```
|
||||
- Example (ESM):
|
||||
```js
|
||||
export default function mySkill() { ... }
|
||||
```
|
||||
- **Commit Messages:** Follow [Conventional Commits](https://www.conventionalcommits.org/) with prefixes such as `fix`, `feat`, `docs`, `chore`.
|
||||
- Example: `feat: add support for new install target`
|
||||
- **Test Files:** Use the pattern `*.test.js` for test files.
|
||||
|
||||
## When to Use This Skill
|
||||
## Workflows
|
||||
|
||||
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
|
||||
### Add or Update a Skill
|
||||
**Trigger:** When introducing or updating a workflow, agent, or capability
|
||||
**Command:** `/add-skill`
|
||||
|
||||
## Commit Conventions
|
||||
1. Create or update a `SKILL.md` file in one of:
|
||||
- `skills/<skill-name>/SKILL.md`
|
||||
- `.agents/skills/<skill-name>/SKILL.md`
|
||||
- `.claude/skills/<skill-name>/SKILL.md`
|
||||
2. Optionally update `AGENTS.md`, `README.md`, or `manifests/install-modules.json` to reference the new skill.
|
||||
3. Document the skill's usage and integration points.
|
||||
|
||||
Follow these commit message conventions based on 500 analyzed commits.
|
||||
|
||||
### Commit Style: Conventional Commits
|
||||
|
||||
### Prefixes Used
|
||||
|
||||
- `fix`
|
||||
- `feat`
|
||||
- `docs`
|
||||
- `chore`
|
||||
|
||||
### Message Guidelines
|
||||
|
||||
- Average message length: ~56 characters
|
||||
- Keep first line concise and descriptive
|
||||
- Use imperative mood ("Add feature" not "Added feature")
|
||||
|
||||
|
||||
*Commit message example*
|
||||
|
||||
```text
|
||||
refactor: simplify redundant checks; normalize getInstalledPlugin inputs
|
||||
**Example:**
|
||||
```bash
|
||||
/add-skill
|
||||
```
|
||||
|
||||
*Commit message example*
|
||||
|
||||
```text
|
||||
fix: preserve file permissions in writeJsonAtomic
|
||||
```
|
||||
|
||||
*Commit message example*
|
||||
|
||||
```text
|
||||
style: apply linter formatting to pluginRegistry.js
|
||||
```
|
||||
|
||||
*Commit message example*
|
||||
|
||||
```text
|
||||
chore: update yarn.lock
|
||||
```
|
||||
|
||||
*Commit message example*
|
||||
|
||||
```text
|
||||
feat(plugin): add marketplace add/install system
|
||||
```
|
||||
|
||||
*Commit message example*
|
||||
|
||||
```text
|
||||
fix: ship marketplaces.json as empty stub to prevent duplicate-add error
|
||||
```
|
||||
|
||||
*Commit message example*
|
||||
|
||||
```text
|
||||
fix: normalize lookups, atomic writes, reject empty marketplace specifier
|
||||
```
|
||||
|
||||
*Commit message example*
|
||||
|
||||
```text
|
||||
refactor: extract shared readJsonFile helper; fix single-dash flag parsing
|
||||
```
|
||||
|
||||
## 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`
|
||||
- `.prettierrc`
|
||||
- `eslint.config.js`
|
||||
- `package.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*
|
||||
|
||||
```typescript
|
||||
// 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*
|
||||
|
||||
```typescript
|
||||
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**:
|
||||
1. Add feature implementation
|
||||
2. Add tests for feature
|
||||
3. Update documentation
|
||||
|
||||
**Files typically involved**:
|
||||
- `.opencode/*`
|
||||
- `.opencode/plugins/*`
|
||||
- `.opencode/plugins/lib/*`
|
||||
- `**/*.test.*`
|
||||
|
||||
**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)
|
||||
```
|
||||
|
||||
### Add New Command Or Agentic Workflow
|
||||
|
||||
Adds a new command or agentic workflow to the system, often including new .md command files, agent definitions, and skill orchestrators.
|
||||
|
||||
**Frequency**: ~3 times per month
|
||||
|
||||
**Steps**:
|
||||
1. Create one or more new command markdown files in commands/ (e.g., gan-build.md, santa-loop.md, prp-*.md)
|
||||
2. Add or update agent definitions in agents/ (e.g., gan-generator.md, opensource-forker.md)
|
||||
3. Add or update skill orchestrator in skills/ (e.g., skills/gan-style-harness/SKILL.md, skills/opensource-pipeline/SKILL.md)
|
||||
4. Optionally add shell orchestrators or scripts (e.g., scripts/gan-harness.sh)
|
||||
5. Optionally add documentation or examples
|
||||
|
||||
**Files typically involved**:
|
||||
- `commands/*.md`
|
||||
- `agents/*.md`
|
||||
- `skills/*/SKILL.md`
|
||||
- `scripts/*.sh`
|
||||
- `examples/*`
|
||||
|
||||
**Example commit sequence**:
|
||||
```
|
||||
Create one or more new command markdown files in commands/ (e.g., gan-build.md, santa-loop.md, prp-*.md)
|
||||
Add or update agent definitions in agents/ (e.g., gan-generator.md, opensource-forker.md)
|
||||
Add or update skill orchestrator in skills/ (e.g., skills/gan-style-harness/SKILL.md, skills/opensource-pipeline/SKILL.md)
|
||||
Optionally add shell orchestrators or scripts (e.g., scripts/gan-harness.sh)
|
||||
Optionally add documentation or examples
|
||||
```
|
||||
|
||||
### Add Or Update Plugin Marketplace System
|
||||
|
||||
Implements or refines the plugin marketplace system, including registry helpers, CLI scripts, JSON stubs, and documentation.
|
||||
|
||||
**Frequency**: ~2 times per month
|
||||
|
||||
**Steps**:
|
||||
1. Edit or create scripts/lib/pluginRegistry.js for registry helpers
|
||||
2. Edit or create scripts/pluginMarketplace.js and/or scripts/pluginInstall.js for CLI commands
|
||||
3. Edit .claude-plugin/marketplaces.json and/or .claude-plugin/installed-plugins.json as stubs or for schema changes
|
||||
4. Update or add tests in tests/lib/pluginRegistry.test.js
|
||||
5. Update or create documentation in commands/plugin-marketplace.md and/or commands/plugin-install.md
|
||||
6. Optionally update root docs (README.md, AGENTS.md, etc.)
|
||||
|
||||
**Files typically involved**:
|
||||
- `scripts/lib/pluginRegistry.js`
|
||||
- `scripts/pluginMarketplace.js`
|
||||
- `scripts/pluginInstall.js`
|
||||
- `.claude-plugin/marketplaces.json`
|
||||
- `.claude-plugin/installed-plugins.json`
|
||||
- `tests/lib/pluginRegistry.test.js`
|
||||
- `commands/plugin-marketplace.md`
|
||||
- `commands/plugin-install.md`
|
||||
- `README.md`
|
||||
- `AGENTS.md`
|
||||
|
||||
**Example commit sequence**:
|
||||
```
|
||||
Edit or create scripts/lib/pluginRegistry.js for registry helpers
|
||||
Edit or create scripts/pluginMarketplace.js and/or scripts/pluginInstall.js for CLI commands
|
||||
Edit .claude-plugin/marketplaces.json and/or .claude-plugin/installed-plugins.json as stubs or for schema changes
|
||||
Update or add tests in tests/lib/pluginRegistry.test.js
|
||||
Update or create documentation in commands/plugin-marketplace.md and/or commands/plugin-install.md
|
||||
Optionally update root docs (README.md, AGENTS.md, etc.)
|
||||
```
|
||||
|
||||
### Add New Install Target Or Adaptation
|
||||
|
||||
Adds a new install target (e.g., Gemini, CodeBuddy) to the system, including scripts, schemas, and tests.
|
||||
|
||||
**Frequency**: ~2 times per month
|
||||
|
||||
**Steps**:
|
||||
1. Add new install scripts and docs under a dedicated directory (e.g., .gemini/, .codebuddy/)
|
||||
2. Update manifests/install-modules.json to register the new target
|
||||
3. Update or add schema files (schemas/ecc-install-config.schema.json, schemas/install-modules.schema.json)
|
||||
4. Edit or add scripts/lib/install-manifests.js and scripts/lib/install-targets/*.js for logic
|
||||
5. Add or update tests in tests/lib/install-targets.test.js
|
||||
6. Update documentation (README.md, .gemini/GEMINI.md, etc.)
|
||||
|
||||
**Files typically involved**:
|
||||
- `.gemini/*`
|
||||
- `.codebuddy/*`
|
||||
- `manifests/install-modules.json`
|
||||
- `schemas/ecc-install-config.schema.json`
|
||||
- `schemas/install-modules.schema.json`
|
||||
- `scripts/lib/install-manifests.js`
|
||||
- `scripts/lib/install-targets/*.js`
|
||||
- `tests/lib/install-targets.test.js`
|
||||
- `README.md`
|
||||
|
||||
**Example commit sequence**:
|
||||
```
|
||||
Add new install scripts and docs under a dedicated directory (e.g., .gemini/, .codebuddy/)
|
||||
Update manifests/install-modules.json to register the new target
|
||||
Update or add schema files (schemas/ecc-install-config.schema.json, schemas/install-modules.schema.json)
|
||||
Edit or add scripts/lib/install-manifests.js and scripts/lib/install-targets/*.js for logic
|
||||
Add or update tests in tests/lib/install-targets.test.js
|
||||
Update documentation (README.md, .gemini/GEMINI.md, etc.)
|
||||
```
|
||||
|
||||
### Add Or Update Hook Or Session Management
|
||||
|
||||
Implements or refines hooks and session management logic, including accumulator patterns, session start/end, and related tests.
|
||||
|
||||
**Frequency**: ~2 times per month
|
||||
|
||||
**Steps**:
|
||||
1. Edit or create scripts/hooks/*.js for hook logic (e.g., post-edit-accumulator.js, stop-format-typecheck.js, session-start.js)
|
||||
2. Update hooks/hooks.json for hook configuration
|
||||
3. Add or update tests in tests/hooks/*.test.js
|
||||
4. Optionally update shell scripts (scripts/hooks/*.sh)
|
||||
5. Optionally update adapters (.cursor/hooks/after-file-edit.js)
|
||||
|
||||
**Files typically involved**:
|
||||
- `scripts/hooks/*.js`
|
||||
- `hooks/hooks.json`
|
||||
- `tests/hooks/*.test.js`
|
||||
- `scripts/hooks/*.sh`
|
||||
- `.cursor/hooks/after-file-edit.js`
|
||||
|
||||
**Example commit sequence**:
|
||||
```
|
||||
Edit or create scripts/hooks/*.js for hook logic (e.g., post-edit-accumulator.js, stop-format-typecheck.js, session-start.js)
|
||||
Update hooks/hooks.json for hook configuration
|
||||
Add or update tests in tests/hooks/*.test.js
|
||||
Optionally update shell scripts (scripts/hooks/*.sh)
|
||||
Optionally update adapters (.cursor/hooks/after-file-edit.js)
|
||||
```
|
||||
|
||||
### Add Or Update Skill Or Agent
|
||||
|
||||
Adds or updates a skill or agent definition, often including a new SKILL.md and/or agent .md, sometimes with supporting config.
|
||||
|
||||
**Frequency**: ~2 times per month
|
||||
|
||||
**Steps**:
|
||||
1. Create or edit skills/*/SKILL.md
|
||||
2. Create or edit agents/*.md
|
||||
3. Optionally update mcp-configs/mcp-servers.json or other config files
|
||||
4. Optionally update AGENTS.md or related documentation
|
||||
|
||||
**Files typically involved**:
|
||||
- `skills/*/SKILL.md`
|
||||
- `agents/*.md`
|
||||
- `mcp-configs/mcp-servers.json`
|
||||
- `AGENTS.md`
|
||||
|
||||
**Example commit sequence**:
|
||||
```
|
||||
Create or edit skills/*/SKILL.md
|
||||
Create or edit agents/*.md
|
||||
Optionally update mcp-configs/mcp-servers.json or other config files
|
||||
Optionally update AGENTS.md or related documentation
|
||||
```
|
||||
|
||||
### Dependabot Or Automated Dependency Update
|
||||
|
||||
Automated workflow to update dependencies via Dependabot or similar, touching lockfiles and workflow YAMLs.
|
||||
|
||||
**Frequency**: ~4 times per month
|
||||
|
||||
**Steps**:
|
||||
1. Update package.json and/or yarn.lock
|
||||
2. Update .github/workflows/*.yml as needed for new dependency versions
|
||||
3. Commit with a standardized message referencing the dependency and version
|
||||
|
||||
**Files typically involved**:
|
||||
- `package.json`
|
||||
- `yarn.lock`
|
||||
- `.github/workflows/*.yml`
|
||||
|
||||
**Example commit sequence**:
|
||||
```
|
||||
Update package.json and/or yarn.lock
|
||||
Update .github/workflows/*.yml as needed for new dependency versions
|
||||
Commit with a standardized message referencing the dependency and version
|
||||
```
|
||||
|
||||
|
||||
## 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](https://ecc.tools). Review and customize as needed for your team.*
|
||||
### Add or Update a Command
|
||||
**Trigger:** When adding a new CLI command, workflow, or extending command capabilities
|
||||
**Command:** `/add-command`
|
||||
|
||||
1. Create or update a markdown file in `commands/` (e.g., `commands/<command>.md`).
|
||||
2. Optionally update related documentation (`README.md`, `AGENTS.md`).
|
||||
3. If the command is part of a workflow, update or create associated artifacts or scripts.
|
||||
|
||||
**Example:**
|
||||
```bash
|
||||
/add-command
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### Add or Update an Agent
|
||||
**Trigger:** When introducing a new agent or updating agent logic
|
||||
**Command:** `/add-agent`
|
||||
|
||||
1. Create or update agent definition markdown in `agents/<agent-name>.md` or `.opencode/prompts/agents/<agent>.txt`.
|
||||
2. Register or update the agent in `opencode.json` or related config.
|
||||
3. Update `AGENTS.md` with new agent details.
|
||||
|
||||
**Example:**
|
||||
```bash
|
||||
/add-agent
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### Add or Update an Install Target
|
||||
**Trigger:** When supporting a new platform/tool for installation/integration
|
||||
**Command:** `/add-install-target`
|
||||
|
||||
1. Create or update install scripts (`.sh`/`.js`) and documentation in a dot-directory (e.g., `.codebuddy/`, `.gemini/`).
|
||||
2. Update `manifests/install-modules.json` and `schemas/ecc-install-config.schema.json`.
|
||||
3. Update `scripts/lib/install-manifests.js` and `scripts/lib/install-targets/<target>.js`.
|
||||
4. Add or update tests for install targets.
|
||||
|
||||
**Example:**
|
||||
```bash
|
||||
/add-install-target
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### Add or Update CI Workflow
|
||||
**Trigger:** When updating CI workflows, adding new checks, or bumping dependencies
|
||||
**Command:** `/update-ci`
|
||||
|
||||
1. Edit or add files in `.github/workflows/`.
|
||||
2. Update `package.json` or `yarn.lock` if dependency-related.
|
||||
3. Test CI to ensure the new workflow or dependency works as intended.
|
||||
|
||||
**Example:**
|
||||
```bash
|
||||
/update-ci
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### Update Hooks or Validation Scripts
|
||||
**Trigger:** When improving or fixing pre/post hooks, or validation logic for edits and CI
|
||||
**Command:** `/update-hooks`
|
||||
|
||||
1. Edit `hooks/hooks.json` and supporting scripts in `scripts/hooks/`.
|
||||
2. Update or add tests in `tests/hooks/` or `tests/scripts/`.
|
||||
3. Optionally update related documentation.
|
||||
|
||||
**Example:**
|
||||
```bash
|
||||
/update-hooks
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### Add or Update Documentation
|
||||
**Trigger:** When documenting new workflows, updating guides, or adding troubleshooting info
|
||||
**Command:** `/update-docs`
|
||||
|
||||
1. Edit or add markdown files in `docs/`, `WORKING-CONTEXT.md`, or `the-shortform-guide.md`.
|
||||
2. Update `README.md` and/or `README.zh-CN.md`.
|
||||
3. Optionally update related skill or agent docs.
|
||||
|
||||
**Example:**
|
||||
```bash
|
||||
/update-docs
|
||||
```
|
||||
|
||||
## Testing Patterns
|
||||
|
||||
- **Test Files:** Place tests in the same directory as the code or in a `tests/` directory, using the `*.test.js` naming convention.
|
||||
- **Framework:** No specific testing framework detected; use standard JavaScript test runners (e.g., Jest, Mocha) as appropriate.
|
||||
- **Example Test File:**
|
||||
```js
|
||||
// mySkill.test.js
|
||||
const mySkill = require('./mySkill');
|
||||
|
||||
test('should return expected result', () => {
|
||||
expect(mySkill('input')).toBe('expected output');
|
||||
});
|
||||
```
|
||||
|
||||
## Commands
|
||||
|
||||
| Command | Purpose |
|
||||
|---------------------|--------------------------------------------------------------|
|
||||
| /add-skill | Add or update a skill (workflow, agent, or capability) |
|
||||
| /add-command | Add or update a command file for new or extended workflows |
|
||||
| /add-agent | Add or update an agent definition |
|
||||
| /add-install-target | Add or update an install target for external integrations |
|
||||
| /update-ci | Add or update CI/CD workflow files or dependencies |
|
||||
| /update-hooks | Update hooks or validation scripts |
|
||||
| /update-docs | Add or update documentation |
|
||||
```
|
||||
|
||||
@@ -1,41 +0,0 @@
|
||||
---
|
||||
name: add-new-command-or-agentic-workflow
|
||||
description: Workflow command scaffold for add-new-command-or-agentic-workflow in everything-claude-code.
|
||||
allowed_tools: ["Bash", "Read", "Write", "Grep", "Glob"]
|
||||
---
|
||||
|
||||
# /add-new-command-or-agentic-workflow
|
||||
|
||||
Use this workflow when working on **add-new-command-or-agentic-workflow** in `everything-claude-code`.
|
||||
|
||||
## Goal
|
||||
|
||||
Adds a new command or agentic workflow to the system, often including new .md command files, agent definitions, and skill orchestrators.
|
||||
|
||||
## Common Files
|
||||
|
||||
- `commands/*.md`
|
||||
- `agents/*.md`
|
||||
- `skills/*/SKILL.md`
|
||||
- `scripts/*.sh`
|
||||
- `examples/*`
|
||||
|
||||
## Suggested Sequence
|
||||
|
||||
1. Understand the current state and failure mode before editing.
|
||||
2. Make the smallest coherent change that satisfies the workflow goal.
|
||||
3. Run the most relevant verification for touched files.
|
||||
4. Summarize what changed and what still needs review.
|
||||
|
||||
## Typical Commit Signals
|
||||
|
||||
- Create one or more new command markdown files in commands/ (e.g., gan-build.md, santa-loop.md, prp-*.md)
|
||||
- Add or update agent definitions in agents/ (e.g., gan-generator.md, opensource-forker.md)
|
||||
- Add or update skill orchestrator in skills/ (e.g., skills/gan-style-harness/SKILL.md, skills/opensource-pipeline/SKILL.md)
|
||||
- Optionally add shell orchestrators or scripts (e.g., scripts/gan-harness.sh)
|
||||
- Optionally add documentation or examples
|
||||
|
||||
## Notes
|
||||
|
||||
- Treat this as a scaffold, not a hard-coded script.
|
||||
- Update the command if the workflow evolves materially.
|
||||
@@ -1,42 +0,0 @@
|
||||
---
|
||||
name: add-or-update-plugin-marketplace-system
|
||||
description: Workflow command scaffold for add-or-update-plugin-marketplace-system in everything-claude-code.
|
||||
allowed_tools: ["Bash", "Read", "Write", "Grep", "Glob"]
|
||||
---
|
||||
|
||||
# /add-or-update-plugin-marketplace-system
|
||||
|
||||
Use this workflow when working on **add-or-update-plugin-marketplace-system** in `everything-claude-code`.
|
||||
|
||||
## Goal
|
||||
|
||||
Implements or refines the plugin marketplace system, including registry helpers, CLI scripts, JSON stubs, and documentation.
|
||||
|
||||
## Common Files
|
||||
|
||||
- `scripts/lib/pluginRegistry.js`
|
||||
- `scripts/pluginMarketplace.js`
|
||||
- `scripts/pluginInstall.js`
|
||||
- `.claude-plugin/marketplaces.json`
|
||||
- `.claude-plugin/installed-plugins.json`
|
||||
- `tests/lib/pluginRegistry.test.js`
|
||||
|
||||
## Suggested Sequence
|
||||
|
||||
1. Understand the current state and failure mode before editing.
|
||||
2. Make the smallest coherent change that satisfies the workflow goal.
|
||||
3. Run the most relevant verification for touched files.
|
||||
4. Summarize what changed and what still needs review.
|
||||
|
||||
## Typical Commit Signals
|
||||
|
||||
- Edit or create scripts/lib/pluginRegistry.js for registry helpers
|
||||
- Edit or create scripts/pluginMarketplace.js and/or scripts/pluginInstall.js for CLI commands
|
||||
- Edit .claude-plugin/marketplaces.json and/or .claude-plugin/installed-plugins.json as stubs or for schema changes
|
||||
- Update or add tests in tests/lib/pluginRegistry.test.js
|
||||
- Update or create documentation in commands/plugin-marketplace.md and/or commands/plugin-install.md
|
||||
|
||||
## Notes
|
||||
|
||||
- Treat this as a scaffold, not a hard-coded script.
|
||||
- Update the command if the workflow evolves materially.
|
||||
40
.claude/commands/add-or-update-skill.md
Normal file
40
.claude/commands/add-or-update-skill.md
Normal file
@@ -0,0 +1,40 @@
|
||||
---
|
||||
name: add-or-update-skill
|
||||
description: Workflow command scaffold for add-or-update-skill in everything-claude-code.
|
||||
allowed_tools: ["Bash", "Read", "Write", "Grep", "Glob"]
|
||||
---
|
||||
|
||||
# /add-or-update-skill
|
||||
|
||||
Use this workflow when working on **add-or-update-skill** in `everything-claude-code`.
|
||||
|
||||
## Goal
|
||||
|
||||
Adds a new skill or updates an existing skill, typically for a new workflow, agent, or capability.
|
||||
|
||||
## Common Files
|
||||
|
||||
- `skills/*/SKILL.md`
|
||||
- `.agents/skills/*/SKILL.md`
|
||||
- `.claude/skills/*/SKILL.md`
|
||||
- `AGENTS.md`
|
||||
- `README.md`
|
||||
- `manifests/install-modules.json`
|
||||
|
||||
## Suggested Sequence
|
||||
|
||||
1. Understand the current state and failure mode before editing.
|
||||
2. Make the smallest coherent change that satisfies the workflow goal.
|
||||
3. Run the most relevant verification for touched files.
|
||||
4. Summarize what changed and what still needs review.
|
||||
|
||||
## Typical Commit Signals
|
||||
|
||||
- Create or update a SKILL.md file in skills/<skill-name>/ or .agents/skills/<skill-name>/ or .claude/skills/<skill-name>/
|
||||
- Optionally update AGENTS.md, README.md, or manifests/install-modules.json to reference the new skill
|
||||
- Document the skill's usage and integration points
|
||||
|
||||
## Notes
|
||||
|
||||
- Treat this as a scaffold, not a hard-coded script.
|
||||
- Update the command if the workflow evolves materially.
|
||||
35
.claude/commands/refactoring.md
Normal file
35
.claude/commands/refactoring.md
Normal file
@@ -0,0 +1,35 @@
|
||||
---
|
||||
name: refactoring
|
||||
description: Workflow command scaffold for refactoring in everything-claude-code.
|
||||
allowed_tools: ["Bash", "Read", "Write", "Grep", "Glob"]
|
||||
---
|
||||
|
||||
# /refactoring
|
||||
|
||||
Use this workflow when working on **refactoring** in `everything-claude-code`.
|
||||
|
||||
## Goal
|
||||
|
||||
Code refactoring and cleanup workflow
|
||||
|
||||
## Common Files
|
||||
|
||||
- `src/**/*`
|
||||
|
||||
## Suggested Sequence
|
||||
|
||||
1. Understand the current state and failure mode before editing.
|
||||
2. Make the smallest coherent change that satisfies the workflow goal.
|
||||
3. Run the most relevant verification for touched files.
|
||||
4. Summarize what changed and what still needs review.
|
||||
|
||||
## Typical Commit Signals
|
||||
|
||||
- Ensure tests pass before refactor
|
||||
- Refactor code structure
|
||||
- Verify tests still pass
|
||||
|
||||
## Notes
|
||||
|
||||
- Treat this as a scaffold, not a hard-coded script.
|
||||
- Update the command if the workflow evolves materially.
|
||||
@@ -2,7 +2,7 @@
|
||||
"version": "1.3",
|
||||
"schemaVersion": "1.0",
|
||||
"generatedBy": "ecc-tools",
|
||||
"generatedAt": "2026-04-01T22:56:13.232Z",
|
||||
"generatedAt": "2026-04-01T22:57:31.655Z",
|
||||
"repo": "https://github.com/affaan-m/everything-claude-code",
|
||||
"profiles": {
|
||||
"requested": "full",
|
||||
@@ -149,8 +149,8 @@
|
||||
".claude/team/everything-claude-code-team-config.json",
|
||||
".claude/enterprise/controls.md",
|
||||
".claude/commands/feature-development.md",
|
||||
".claude/commands/add-new-command-or-agentic-workflow.md",
|
||||
".claude/commands/add-or-update-plugin-marketplace-system.md"
|
||||
".claude/commands/refactoring.md",
|
||||
".claude/commands/add-or-update-skill.md"
|
||||
],
|
||||
"packageFiles": {
|
||||
"runtime-core": [
|
||||
@@ -179,8 +179,8 @@
|
||||
],
|
||||
"workflow-pack": [
|
||||
".claude/commands/feature-development.md",
|
||||
".claude/commands/add-new-command-or-agentic-workflow.md",
|
||||
".claude/commands/add-or-update-plugin-marketplace-system.md"
|
||||
".claude/commands/refactoring.md",
|
||||
".claude/commands/add-or-update-skill.md"
|
||||
]
|
||||
},
|
||||
"moduleFiles": {
|
||||
@@ -210,8 +210,8 @@
|
||||
],
|
||||
"workflow-pack": [
|
||||
".claude/commands/feature-development.md",
|
||||
".claude/commands/add-new-command-or-agentic-workflow.md",
|
||||
".claude/commands/add-or-update-plugin-marketplace-system.md"
|
||||
".claude/commands/refactoring.md",
|
||||
".claude/commands/add-or-update-skill.md"
|
||||
]
|
||||
},
|
||||
"files": [
|
||||
@@ -292,13 +292,13 @@
|
||||
},
|
||||
{
|
||||
"moduleId": "workflow-pack",
|
||||
"path": ".claude/commands/add-new-command-or-agentic-workflow.md",
|
||||
"description": "Workflow command scaffold for add-new-command-or-agentic-workflow."
|
||||
"path": ".claude/commands/refactoring.md",
|
||||
"description": "Workflow command scaffold for refactoring."
|
||||
},
|
||||
{
|
||||
"moduleId": "workflow-pack",
|
||||
"path": ".claude/commands/add-or-update-plugin-marketplace-system.md",
|
||||
"description": "Workflow command scaffold for add-or-update-plugin-marketplace-system."
|
||||
"path": ".claude/commands/add-or-update-skill.md",
|
||||
"description": "Workflow command scaffold for add-or-update-skill."
|
||||
}
|
||||
],
|
||||
"workflows": [
|
||||
@@ -307,12 +307,12 @@
|
||||
"path": ".claude/commands/feature-development.md"
|
||||
},
|
||||
{
|
||||
"command": "add-new-command-or-agentic-workflow",
|
||||
"path": ".claude/commands/add-new-command-or-agentic-workflow.md"
|
||||
"command": "refactoring",
|
||||
"path": ".claude/commands/refactoring.md"
|
||||
},
|
||||
{
|
||||
"command": "add-or-update-plugin-marketplace-system",
|
||||
"path": ".claude/commands/add-or-update-plugin-marketplace-system.md"
|
||||
"command": "add-or-update-skill",
|
||||
"path": ".claude/commands/add-or-update-skill.md"
|
||||
}
|
||||
],
|
||||
"adapters": {
|
||||
@@ -321,8 +321,8 @@
|
||||
"identityPath": ".claude/identity.json",
|
||||
"commandPaths": [
|
||||
".claude/commands/feature-development.md",
|
||||
".claude/commands/add-new-command-or-agentic-workflow.md",
|
||||
".claude/commands/add-or-update-plugin-marketplace-system.md"
|
||||
".claude/commands/refactoring.md",
|
||||
".claude/commands/add-or-update-skill.md"
|
||||
]
|
||||
},
|
||||
"codex": {
|
||||
|
||||
@@ -10,5 +10,5 @@
|
||||
"javascript"
|
||||
],
|
||||
"suggestedBy": "ecc-tools-repo-analysis",
|
||||
"createdAt": "2026-04-01T22:56:57.484Z"
|
||||
"createdAt": "2026-04-01T22:58:08.299Z"
|
||||
}
|
||||
@@ -18,4 +18,4 @@ Use this when the task is documentation-heavy, source-sensitive, or requires bro
|
||||
|
||||
- Primary language: JavaScript
|
||||
- Framework: Not detected
|
||||
- Workflows detected: 7
|
||||
- Workflows detected: 9
|
||||
@@ -25,8 +25,8 @@ Generated by ECC Tools from repository history. Review before treating it as a h
|
||||
## Detected Workflows
|
||||
|
||||
- feature-development: Standard feature implementation workflow
|
||||
- add-new-command-or-agentic-workflow: Adds a new command or agentic workflow to the system, often including new .md command files, agent definitions, and skill orchestrators.
|
||||
- add-or-update-plugin-marketplace-system: Implements or refines the plugin marketplace system, including registry helpers, CLI scripts, JSON stubs, and documentation.
|
||||
- refactoring: Code refactoring and cleanup workflow
|
||||
- add-or-update-skill: Adds a new skill or updates an existing skill, typically for a new workflow, agent, or capability.
|
||||
|
||||
## Review Reminder
|
||||
|
||||
|
||||
@@ -1,409 +1,166 @@
|
||||
---
|
||||
name: everything-claude-code-conventions
|
||||
description: Development conventions and patterns for everything-claude-code. JavaScript project with conventional commits.
|
||||
---
|
||||
```markdown
|
||||
# everything-claude-code Development Patterns
|
||||
|
||||
# Everything Claude Code Conventions
|
||||
|
||||
> Generated from [affaan-m/everything-claude-code](https://github.com/affaan-m/everything-claude-code) on 2026-04-01
|
||||
> Auto-generated skill from repository analysis
|
||||
|
||||
## Overview
|
||||
|
||||
This skill teaches Claude the development patterns and conventions used in everything-claude-code.
|
||||
This skill introduces the core development patterns, coding conventions, and common workflows for contributing to the `everything-claude-code` repository. The project is JavaScript-based, with no framework dependencies, and emphasizes modularity, agentic skills, and workflow automation. This guide covers file organization, commit conventions, code style, workflow steps, and testing patterns to help you contribute effectively and consistently.
|
||||
|
||||
## Tech Stack
|
||||
## Coding Conventions
|
||||
|
||||
- **Primary Language**: JavaScript
|
||||
- **Architecture**: hybrid module organization
|
||||
- **Test Location**: separate
|
||||
- **File Naming:** Use camelCase for JavaScript files and folders.
|
||||
- Example: `mySkill.js`, `installTarget.js`
|
||||
- **Import Style:** Use relative imports.
|
||||
- Example:
|
||||
```js
|
||||
const helper = require('./utils/helper');
|
||||
```
|
||||
- **Export Style:** Mixed (both CommonJS and ES module styles may be present).
|
||||
- Example (CommonJS):
|
||||
```js
|
||||
module.exports = function mySkill() { ... };
|
||||
```
|
||||
- Example (ESM):
|
||||
```js
|
||||
export default function mySkill() { ... }
|
||||
```
|
||||
- **Commit Messages:** Follow [Conventional Commits](https://www.conventionalcommits.org/) with prefixes such as `fix`, `feat`, `docs`, `chore`.
|
||||
- Example: `feat: add support for new install target`
|
||||
- **Test Files:** Use the pattern `*.test.js` for test files.
|
||||
|
||||
## When to Use This Skill
|
||||
## Workflows
|
||||
|
||||
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
|
||||
### Add or Update a Skill
|
||||
**Trigger:** When introducing or updating a workflow, agent, or capability
|
||||
**Command:** `/add-skill`
|
||||
|
||||
## Commit Conventions
|
||||
1. Create or update a `SKILL.md` file in one of:
|
||||
- `skills/<skill-name>/SKILL.md`
|
||||
- `.agents/skills/<skill-name>/SKILL.md`
|
||||
- `.claude/skills/<skill-name>/SKILL.md`
|
||||
2. Optionally update `AGENTS.md`, `README.md`, or `manifests/install-modules.json` to reference the new skill.
|
||||
3. Document the skill's usage and integration points.
|
||||
|
||||
Follow these commit message conventions based on 500 analyzed commits.
|
||||
|
||||
### Commit Style: Conventional Commits
|
||||
|
||||
### Prefixes Used
|
||||
|
||||
- `fix`
|
||||
- `feat`
|
||||
- `docs`
|
||||
- `chore`
|
||||
|
||||
### Message Guidelines
|
||||
|
||||
- Average message length: ~56 characters
|
||||
- Keep first line concise and descriptive
|
||||
- Use imperative mood ("Add feature" not "Added feature")
|
||||
|
||||
|
||||
*Commit message example*
|
||||
|
||||
```text
|
||||
refactor: simplify redundant checks; normalize getInstalledPlugin inputs
|
||||
**Example:**
|
||||
```bash
|
||||
/add-skill
|
||||
```
|
||||
|
||||
*Commit message example*
|
||||
|
||||
```text
|
||||
fix: preserve file permissions in writeJsonAtomic
|
||||
```
|
||||
|
||||
*Commit message example*
|
||||
|
||||
```text
|
||||
style: apply linter formatting to pluginRegistry.js
|
||||
```
|
||||
|
||||
*Commit message example*
|
||||
|
||||
```text
|
||||
chore: update yarn.lock
|
||||
```
|
||||
|
||||
*Commit message example*
|
||||
|
||||
```text
|
||||
feat(plugin): add marketplace add/install system
|
||||
```
|
||||
|
||||
*Commit message example*
|
||||
|
||||
```text
|
||||
fix: ship marketplaces.json as empty stub to prevent duplicate-add error
|
||||
```
|
||||
|
||||
*Commit message example*
|
||||
|
||||
```text
|
||||
fix: normalize lookups, atomic writes, reject empty marketplace specifier
|
||||
```
|
||||
|
||||
*Commit message example*
|
||||
|
||||
```text
|
||||
refactor: extract shared readJsonFile helper; fix single-dash flag parsing
|
||||
```
|
||||
|
||||
## 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`
|
||||
- `.prettierrc`
|
||||
- `eslint.config.js`
|
||||
- `package.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*
|
||||
|
||||
```typescript
|
||||
// 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*
|
||||
|
||||
```typescript
|
||||
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**:
|
||||
1. Add feature implementation
|
||||
2. Add tests for feature
|
||||
3. Update documentation
|
||||
|
||||
**Files typically involved**:
|
||||
- `.opencode/*`
|
||||
- `.opencode/plugins/*`
|
||||
- `.opencode/plugins/lib/*`
|
||||
- `**/*.test.*`
|
||||
|
||||
**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)
|
||||
```
|
||||
|
||||
### Add New Command Or Agentic Workflow
|
||||
|
||||
Adds a new command or agentic workflow to the system, often including new .md command files, agent definitions, and skill orchestrators.
|
||||
|
||||
**Frequency**: ~3 times per month
|
||||
|
||||
**Steps**:
|
||||
1. Create one or more new command markdown files in commands/ (e.g., gan-build.md, santa-loop.md, prp-*.md)
|
||||
2. Add or update agent definitions in agents/ (e.g., gan-generator.md, opensource-forker.md)
|
||||
3. Add or update skill orchestrator in skills/ (e.g., skills/gan-style-harness/SKILL.md, skills/opensource-pipeline/SKILL.md)
|
||||
4. Optionally add shell orchestrators or scripts (e.g., scripts/gan-harness.sh)
|
||||
5. Optionally add documentation or examples
|
||||
|
||||
**Files typically involved**:
|
||||
- `commands/*.md`
|
||||
- `agents/*.md`
|
||||
- `skills/*/SKILL.md`
|
||||
- `scripts/*.sh`
|
||||
- `examples/*`
|
||||
|
||||
**Example commit sequence**:
|
||||
```
|
||||
Create one or more new command markdown files in commands/ (e.g., gan-build.md, santa-loop.md, prp-*.md)
|
||||
Add or update agent definitions in agents/ (e.g., gan-generator.md, opensource-forker.md)
|
||||
Add or update skill orchestrator in skills/ (e.g., skills/gan-style-harness/SKILL.md, skills/opensource-pipeline/SKILL.md)
|
||||
Optionally add shell orchestrators or scripts (e.g., scripts/gan-harness.sh)
|
||||
Optionally add documentation or examples
|
||||
```
|
||||
|
||||
### Add Or Update Plugin Marketplace System
|
||||
|
||||
Implements or refines the plugin marketplace system, including registry helpers, CLI scripts, JSON stubs, and documentation.
|
||||
|
||||
**Frequency**: ~2 times per month
|
||||
|
||||
**Steps**:
|
||||
1. Edit or create scripts/lib/pluginRegistry.js for registry helpers
|
||||
2. Edit or create scripts/pluginMarketplace.js and/or scripts/pluginInstall.js for CLI commands
|
||||
3. Edit .claude-plugin/marketplaces.json and/or .claude-plugin/installed-plugins.json as stubs or for schema changes
|
||||
4. Update or add tests in tests/lib/pluginRegistry.test.js
|
||||
5. Update or create documentation in commands/plugin-marketplace.md and/or commands/plugin-install.md
|
||||
6. Optionally update root docs (README.md, AGENTS.md, etc.)
|
||||
|
||||
**Files typically involved**:
|
||||
- `scripts/lib/pluginRegistry.js`
|
||||
- `scripts/pluginMarketplace.js`
|
||||
- `scripts/pluginInstall.js`
|
||||
- `.claude-plugin/marketplaces.json`
|
||||
- `.claude-plugin/installed-plugins.json`
|
||||
- `tests/lib/pluginRegistry.test.js`
|
||||
- `commands/plugin-marketplace.md`
|
||||
- `commands/plugin-install.md`
|
||||
- `README.md`
|
||||
- `AGENTS.md`
|
||||
|
||||
**Example commit sequence**:
|
||||
```
|
||||
Edit or create scripts/lib/pluginRegistry.js for registry helpers
|
||||
Edit or create scripts/pluginMarketplace.js and/or scripts/pluginInstall.js for CLI commands
|
||||
Edit .claude-plugin/marketplaces.json and/or .claude-plugin/installed-plugins.json as stubs or for schema changes
|
||||
Update or add tests in tests/lib/pluginRegistry.test.js
|
||||
Update or create documentation in commands/plugin-marketplace.md and/or commands/plugin-install.md
|
||||
Optionally update root docs (README.md, AGENTS.md, etc.)
|
||||
```
|
||||
|
||||
### Add New Install Target Or Adaptation
|
||||
|
||||
Adds a new install target (e.g., Gemini, CodeBuddy) to the system, including scripts, schemas, and tests.
|
||||
|
||||
**Frequency**: ~2 times per month
|
||||
|
||||
**Steps**:
|
||||
1. Add new install scripts and docs under a dedicated directory (e.g., .gemini/, .codebuddy/)
|
||||
2. Update manifests/install-modules.json to register the new target
|
||||
3. Update or add schema files (schemas/ecc-install-config.schema.json, schemas/install-modules.schema.json)
|
||||
4. Edit or add scripts/lib/install-manifests.js and scripts/lib/install-targets/*.js for logic
|
||||
5. Add or update tests in tests/lib/install-targets.test.js
|
||||
6. Update documentation (README.md, .gemini/GEMINI.md, etc.)
|
||||
|
||||
**Files typically involved**:
|
||||
- `.gemini/*`
|
||||
- `.codebuddy/*`
|
||||
- `manifests/install-modules.json`
|
||||
- `schemas/ecc-install-config.schema.json`
|
||||
- `schemas/install-modules.schema.json`
|
||||
- `scripts/lib/install-manifests.js`
|
||||
- `scripts/lib/install-targets/*.js`
|
||||
- `tests/lib/install-targets.test.js`
|
||||
- `README.md`
|
||||
|
||||
**Example commit sequence**:
|
||||
```
|
||||
Add new install scripts and docs under a dedicated directory (e.g., .gemini/, .codebuddy/)
|
||||
Update manifests/install-modules.json to register the new target
|
||||
Update or add schema files (schemas/ecc-install-config.schema.json, schemas/install-modules.schema.json)
|
||||
Edit or add scripts/lib/install-manifests.js and scripts/lib/install-targets/*.js for logic
|
||||
Add or update tests in tests/lib/install-targets.test.js
|
||||
Update documentation (README.md, .gemini/GEMINI.md, etc.)
|
||||
```
|
||||
|
||||
### Add Or Update Hook Or Session Management
|
||||
|
||||
Implements or refines hooks and session management logic, including accumulator patterns, session start/end, and related tests.
|
||||
|
||||
**Frequency**: ~2 times per month
|
||||
|
||||
**Steps**:
|
||||
1. Edit or create scripts/hooks/*.js for hook logic (e.g., post-edit-accumulator.js, stop-format-typecheck.js, session-start.js)
|
||||
2. Update hooks/hooks.json for hook configuration
|
||||
3. Add or update tests in tests/hooks/*.test.js
|
||||
4. Optionally update shell scripts (scripts/hooks/*.sh)
|
||||
5. Optionally update adapters (.cursor/hooks/after-file-edit.js)
|
||||
|
||||
**Files typically involved**:
|
||||
- `scripts/hooks/*.js`
|
||||
- `hooks/hooks.json`
|
||||
- `tests/hooks/*.test.js`
|
||||
- `scripts/hooks/*.sh`
|
||||
- `.cursor/hooks/after-file-edit.js`
|
||||
|
||||
**Example commit sequence**:
|
||||
```
|
||||
Edit or create scripts/hooks/*.js for hook logic (e.g., post-edit-accumulator.js, stop-format-typecheck.js, session-start.js)
|
||||
Update hooks/hooks.json for hook configuration
|
||||
Add or update tests in tests/hooks/*.test.js
|
||||
Optionally update shell scripts (scripts/hooks/*.sh)
|
||||
Optionally update adapters (.cursor/hooks/after-file-edit.js)
|
||||
```
|
||||
|
||||
### Add Or Update Skill Or Agent
|
||||
|
||||
Adds or updates a skill or agent definition, often including a new SKILL.md and/or agent .md, sometimes with supporting config.
|
||||
|
||||
**Frequency**: ~2 times per month
|
||||
|
||||
**Steps**:
|
||||
1. Create or edit skills/*/SKILL.md
|
||||
2. Create or edit agents/*.md
|
||||
3. Optionally update mcp-configs/mcp-servers.json or other config files
|
||||
4. Optionally update AGENTS.md or related documentation
|
||||
|
||||
**Files typically involved**:
|
||||
- `skills/*/SKILL.md`
|
||||
- `agents/*.md`
|
||||
- `mcp-configs/mcp-servers.json`
|
||||
- `AGENTS.md`
|
||||
|
||||
**Example commit sequence**:
|
||||
```
|
||||
Create or edit skills/*/SKILL.md
|
||||
Create or edit agents/*.md
|
||||
Optionally update mcp-configs/mcp-servers.json or other config files
|
||||
Optionally update AGENTS.md or related documentation
|
||||
```
|
||||
|
||||
### Dependabot Or Automated Dependency Update
|
||||
|
||||
Automated workflow to update dependencies via Dependabot or similar, touching lockfiles and workflow YAMLs.
|
||||
|
||||
**Frequency**: ~4 times per month
|
||||
|
||||
**Steps**:
|
||||
1. Update package.json and/or yarn.lock
|
||||
2. Update .github/workflows/*.yml as needed for new dependency versions
|
||||
3. Commit with a standardized message referencing the dependency and version
|
||||
|
||||
**Files typically involved**:
|
||||
- `package.json`
|
||||
- `yarn.lock`
|
||||
- `.github/workflows/*.yml`
|
||||
|
||||
**Example commit sequence**:
|
||||
```
|
||||
Update package.json and/or yarn.lock
|
||||
Update .github/workflows/*.yml as needed for new dependency versions
|
||||
Commit with a standardized message referencing the dependency and version
|
||||
```
|
||||
|
||||
|
||||
## 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](https://ecc.tools). Review and customize as needed for your team.*
|
||||
### Add or Update a Command
|
||||
**Trigger:** When adding a new CLI command, workflow, or extending command capabilities
|
||||
**Command:** `/add-command`
|
||||
|
||||
1. Create or update a markdown file in `commands/` (e.g., `commands/<command>.md`).
|
||||
2. Optionally update related documentation (`README.md`, `AGENTS.md`).
|
||||
3. If the command is part of a workflow, update or create associated artifacts or scripts.
|
||||
|
||||
**Example:**
|
||||
```bash
|
||||
/add-command
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### Add or Update an Agent
|
||||
**Trigger:** When introducing a new agent or updating agent logic
|
||||
**Command:** `/add-agent`
|
||||
|
||||
1. Create or update agent definition markdown in `agents/<agent-name>.md` or `.opencode/prompts/agents/<agent>.txt`.
|
||||
2. Register or update the agent in `opencode.json` or related config.
|
||||
3. Update `AGENTS.md` with new agent details.
|
||||
|
||||
**Example:**
|
||||
```bash
|
||||
/add-agent
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### Add or Update an Install Target
|
||||
**Trigger:** When supporting a new platform/tool for installation/integration
|
||||
**Command:** `/add-install-target`
|
||||
|
||||
1. Create or update install scripts (`.sh`/`.js`) and documentation in a dot-directory (e.g., `.codebuddy/`, `.gemini/`).
|
||||
2. Update `manifests/install-modules.json` and `schemas/ecc-install-config.schema.json`.
|
||||
3. Update `scripts/lib/install-manifests.js` and `scripts/lib/install-targets/<target>.js`.
|
||||
4. Add or update tests for install targets.
|
||||
|
||||
**Example:**
|
||||
```bash
|
||||
/add-install-target
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### Add or Update CI Workflow
|
||||
**Trigger:** When updating CI workflows, adding new checks, or bumping dependencies
|
||||
**Command:** `/update-ci`
|
||||
|
||||
1. Edit or add files in `.github/workflows/`.
|
||||
2. Update `package.json` or `yarn.lock` if dependency-related.
|
||||
3. Test CI to ensure the new workflow or dependency works as intended.
|
||||
|
||||
**Example:**
|
||||
```bash
|
||||
/update-ci
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### Update Hooks or Validation Scripts
|
||||
**Trigger:** When improving or fixing pre/post hooks, or validation logic for edits and CI
|
||||
**Command:** `/update-hooks`
|
||||
|
||||
1. Edit `hooks/hooks.json` and supporting scripts in `scripts/hooks/`.
|
||||
2. Update or add tests in `tests/hooks/` or `tests/scripts/`.
|
||||
3. Optionally update related documentation.
|
||||
|
||||
**Example:**
|
||||
```bash
|
||||
/update-hooks
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### Add or Update Documentation
|
||||
**Trigger:** When documenting new workflows, updating guides, or adding troubleshooting info
|
||||
**Command:** `/update-docs`
|
||||
|
||||
1. Edit or add markdown files in `docs/`, `WORKING-CONTEXT.md`, or `the-shortform-guide.md`.
|
||||
2. Update `README.md` and/or `README.zh-CN.md`.
|
||||
3. Optionally update related skill or agent docs.
|
||||
|
||||
**Example:**
|
||||
```bash
|
||||
/update-docs
|
||||
```
|
||||
|
||||
## Testing Patterns
|
||||
|
||||
- **Test Files:** Place tests in the same directory as the code or in a `tests/` directory, using the `*.test.js` naming convention.
|
||||
- **Framework:** No specific testing framework detected; use standard JavaScript test runners (e.g., Jest, Mocha) as appropriate.
|
||||
- **Example Test File:**
|
||||
```js
|
||||
// mySkill.test.js
|
||||
const mySkill = require('./mySkill');
|
||||
|
||||
test('should return expected result', () => {
|
||||
expect(mySkill('input')).toBe('expected output');
|
||||
});
|
||||
```
|
||||
|
||||
## Commands
|
||||
|
||||
| Command | Purpose |
|
||||
|---------------------|--------------------------------------------------------------|
|
||||
| /add-skill | Add or update a skill (workflow, agent, or capability) |
|
||||
| /add-command | Add or update a command file for new or extended workflows |
|
||||
| /add-agent | Add or update an agent definition |
|
||||
| /add-install-target | Add or update an install target for external integrations |
|
||||
| /update-ci | Add or update CI/CD workflow files or dependencies |
|
||||
| /update-hooks | Update hooks or validation scripts |
|
||||
| /update-docs | Add or update documentation |
|
||||
```
|
||||
|
||||
@@ -8,8 +8,8 @@
|
||||
],
|
||||
"commandFiles": [
|
||||
".claude/commands/feature-development.md",
|
||||
".claude/commands/add-new-command-or-agentic-workflow.md",
|
||||
".claude/commands/add-or-update-plugin-marketplace-system.md"
|
||||
".claude/commands/refactoring.md",
|
||||
".claude/commands/add-or-update-skill.md"
|
||||
],
|
||||
"updatedAt": "2026-04-01T22:56:13.232Z"
|
||||
"updatedAt": "2026-04-01T22:57:31.655Z"
|
||||
}
|
||||
Reference in New Issue
Block a user