Skip to content

Add contributing guide with pre-commit hook setup for skill sync #115

Description

@sebastientaggart

Problem to Fix

There is no documentation for contributors on how to set up their local development environment for working on Code Cannon itself. In particular, generated skill files must stay in sync with source skills, but there is no guide explaining this requirement or how to enforce it.

Why it Matters

Without this documentation, contributors (including the maintainer on a new machine) can accidentally commit out-of-sync skill files, causing CI workflow failures that are confusing to diagnose.

General Approach

Add a contributing guide that documents the pre-commit hook setup and the sync requirement. Also sync the currently out-of-date generated skill files.

Complexity

Verification / QA effort: trivial
One file to review, and a quick check that the hook install command works as documented.

Acceptance Criteria

  • A docs/contributing.md file exists with instructions for installing the pre-commit hook
  • All generated skill files are in sync with source skills

Metadata

Metadata

Labels

choreRoutine maintenanceready-for-qaIssue is ready to be QA tested

Type

No type

Projects

No projects

Milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions