Introduction
Cowboy is a community-driven protocol. Anyone can propose improvements, from minor documentation fixes to major protocol changes. This guide explains how to contribute effectively.Types of Contributions (At a Glance)
1. Documentation
- Fixes, clarifications, examples
- Process: open a PR
- Typical review: 1–3 days
2. Code
- Bug fixes, features, optimizations
- Process: PR with tests and docs updates
- Checklist: tests pass, style follows, CI green
3. CIPs (Protocol-Level)
- Scope: consensus or normative spec changes
- Process: follow CIP flow below
- Typical review: multi-week (discussion → review → decision)
CIP Process (Essentials)
What Needs a CIP?
- Consensus changes, protocol features, metering changes
- Standard actor interfaces, network protocol changes
- Not needed for docs, SDK-only changes, non-normative tooling/bugfixes
CIP Numbers
CIP numbers are permanent identifiers. Removing a proposal from the published docs does not make its number available for reuse. The next number is not simply the highest published number plus one: numbers are reserved by in-flight drafts and open PRs before they land, so check the repository history and open proposals before choosing one. If a number looks contested, ask before using it. The published sequence currently runs through CIP-45 and has gaps:- Retired: 16, 21, 22.
- Reserved / unpublished: 32, 35, 37, 38, 44.
CIP Status Lifecycle
A new CIP’sStatus line takes exactly one of these values. Some older CIPs (CIP-1, CIP-2, CIP-3, CIP-7, CIP-8, CIP-18, CIP-28, and CIP-36) still carry free-form status text from before this list; normalize the line the next time the CIP is edited.
Living document is reserved for non-normative companion guides and is not a CIP status.
Submitting Your CIP (Short Path)
- Discuss the idea
- Post a “Pre-CIP” in GitHub Issues (opens at launch), category “Proposals”
- Optional: chat in Discord
#proposals - Aim for 1–2 weeks of feedback
- Draft the spec
- Copy the CIP template to
docs/cips/cip-X-short-name.mdand fill in every section - Include: problem, motivation, specification, rationale, security
- CIPs are public domain under CC0 1.0 (see
docs/cips/LICENSE); by submitting one you waive copyright in it - Set
Status: Draftin the header; see CIP Status Lifecycle
- Open the PR
- Branch:
cip/X-your-feature - PR description: summary, motivation, discussion link, checklist
- Review → Decision
- Initial check → community review → core review → last call
- Outcome: Accepted / Needs work / Rejected (with rationale)
- Implementation (if accepted)
- Reference implementation PR + conformance tests → validation on a test network
Review Criteria (Condensed)
- Clarity: clear problem, motivation, and scope
- Technical soundness: secure, feasible, measurable impact
- Integration: explicit dependencies, shared schemas, and complete caller-path coverage
- Community signal: discussion, support, and timing
- Testing/audit: appropriate tests; audits where needed
FAQ (Short)
How long does a CIP take?
How long does a CIP take?
Typically several weeks: discussion → reviews → decision → (optionally) implementation/testing.
Can I update my CIP?
Can I update my CIP?
Yes, while the status is
Draft or Review. Once a CIP is Final, open a new CIP for changes. See CIP Status Lifecycle.What if it’s rejected?
What if it’s rejected?
Address feedback and resubmit later, propose an alternative, or ship as a non-consensus feature.