Skip to content
This repository was archived by the owner on Apr 25, 2026. It is now read-only.

CONTRIBUTING.md

Latest commit

 

History

History
129 lines (87 loc) · 3.22 KB

CONTRIBUTING.md

File metadata and controls

129 lines (87 loc) · 3.22 KB

Contributing to CCO

Thanks for your interest in contributing!

Quick Start

# Clone
git clone https://github.com/sungurerdim/ClaudeCodeOptimizer.git
cd ClaudeCodeOptimizer

Development Environment

Prerequisites

Tool Version Purpose
Go 1.23+ Build installer and statusline binaries
golangci-lint v2.1+ Linting (optional — CI runs it)

Building

# Installer binary
cd extras/installer && go build -o cco .

# Statusline binary
cd extras/statusline && go build -o cco-statusline .

Running Tests

# Both modules
cd extras/installer && go test -race -count=1 ./...
cd extras/statusline && go test -race -count=1 ./...

Running Lint

# Requires golangci-lint v2
golangci-lint run --config ../../.golangci.yml ./...

CI Pipeline

CI runs on every PR to main:

Job What It Checks
Validate YAML frontmatter in all skill/agent files
Manifest Sync extras/installer/manifest.go matches repo files
Go golangci-lint + go test -race for both modules

All three checks must pass before merge.

File Naming

Type Pattern Location
Skills cco-{name}/SKILL.md skills/
Agents cco-agent-{name}.md agents/
Rules cco-rules.md rules/

Making Changes

Adding/Modifying Rules

  1. Edit rules/cco-rules.md (single source of truth)
  2. Update docs/rules.md to reflect changes

Rule categories: Scope Control, Code Integrity, Production Standards, Output Brevity, Verification, Uncertainty Protocol, Session Resilience, Process Discipline, CCO Operations.

Adding a New Skill

  1. Create skills/cco-{name}/SKILL.md with YAML frontmatter
  2. Update extras/installer/manifest.go — add to skillFiles slice (canonical source of truth)
  3. CI manifest-sync job validates this automatically on push
  4. Update docs/skills.md and docs/agents.md if applicable

Updating Documentation

Keep counts in sync when adding/removing files:

# Verify counts (cross-platform: use Glob in Claude Code)
# Skills: 9 (optimize, align, commit, research, docs, blueprint, pr, update, repo)
# Agents: 3 (analyze, apply, research)

Update README.md and docs/ if counts change.

Pull Request Guidelines

  1. Run validation before submitting:

    Windows: Use Git Bash or WSL for verification commands.

    # Verify all files exist
ls rules/cco-rules.md
ls skills/cco-*/SKILL.md | wc -l   # Should be 9
ls agents/cco-agent-*.md | wc -l   # Should be 3

  2. One feature per PR — keep changes focused

  3. Update docs if adding skills, agents, or rules

  4. Follow existing patterns — check similar files for conventions

Code Style

  • Markdown: CommonMark, ATX headers (# not ===)
  • YAML frontmatter for skills and agents
  • Tables for structured data
  • No trailing whitespace

Testing

  • CI validates file structure, frontmatter, and version consistency
  • Go code in extras/ is built and tested in CI
  • All checks must pass before merge

Questions?

Open an issue at github.com/sungurerdim/ClaudeCodeOptimizer/issues