Skip to content

CIP-003: Formalize Community Improvement Plans (CIPs)#8

Open
thebalaa wants to merge 7 commits into
openclaw:mainfrom
hintjen:rfc/003-cip-template
Open

CIP-003: Formalize Community Improvement Plans (CIPs)#8
thebalaa wants to merge 7 commits into
openclaw:mainfrom
hintjen:rfc/003-cip-template

Conversation

@thebalaa

@thebalaa thebalaa commented Mar 8, 2026

Copy link
Copy Markdown

Summary

CIP-003 is the CIP template itself — a meta-proposal that defines the standard format all future Community Improvement Plans must follow. It establishes:

What it defines

  • A metadata header with 13 fields providing full traceability: CIP number (tied to PR#), author, staff champion, status, type, date, originating RFCIP issue, affected teams, discussion links (GitHub + Discord),
    and supersession chain.
  • 10 required sections for the proposal body:
    1. Summary — one-paragraph overview
    2. Motivation — the problem or opportunity
    3. Detailed Design — the core proposal in full detail
    4. Drawbacks — honest costs, risks, and trade-offs
    5. Alternatives — other approaches considered
    6. Prior Art — what other communities have done
    7. Implementation Plan — concrete steps and responsibilities
    8. Timeline — milestones and phasing
    9. Success Metrics — measurable outcomes
    10. Unresolved Questions — open items needing further discussion
  • An AI Disclosure section for transparency when AI tools assist drafting.

Why it matters

CIP-003 is the foundational document of the CIP process. Every future community improvement — whether governance, structural, tooling, or events — will be written against this template. It ensures proposals are
consistently structured, thoroughly considered, and traceable from initial pitch (RFCIP issue) through acceptance and implementation.

This PR was authored with the assistance of Pi coding agent and a custom exploration workbench.
Author accepts responsibility for the qulity of contents herein.

thebalaa added 2 commits March 7, 2026 23:07
- Fully specified meta-CIP documenting the CIP process
- RFCIP issue template for lightweight pitches
- Blank CIP template for future authors
- Process guide (rfcs/README.md)
- Updated issue template config with label reference
@thebalaa thebalaa marked this pull request as ready for review March 8, 2026 05:11
thebalaa and others added 4 commits March 7, 2026 23:16
CIP numbers are now sequential, manually assigned by the champion
when the RFCIP is greenlit. This decouples naming from GitHub
infrastructure and gives the champion explicit responsibility
for number assignment.

@thewilloftheshadow thewilloftheshadow left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Excited to see this merged and implemented!

Comment thread rfcs/README.md
Comment on lines +27 to +30
| `cip:draft` | Initial RFCIP or early CIP PR |
| `cip:discussion` | Under active community review (7-day minimum) |
| `cip:accepted` | Approved by Admin, PR merged |
| `cip:rejected` | Not approved |

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
| `cip:draft` | Initial RFCIP or early CIP PR |
| `cip:discussion` | Under active community review (7-day minimum) |
| `cip:accepted` | Approved by Admin, PR merged |
| `cip:rejected` | Not approved |
| `CIP Status: Draft` | Initial RFCIP or early CIP PR |
| `CIP Status: Discussion` | Under active community review (7-day minimum) |
| `CIP Status: Accepted` | Approved by Admin, PR merged |
| `CIP Status: Rejected` | Not approved |

For human-used labels, I like having this format

Comment thread rfcs/README.md
Comment on lines +36 to +39
| `cip:governance` | Rules, policies, processes |
| `cip:structural` | Channels, roles, team changes |
| `cip:tooling` | Bots, automation, integrations |
| `cip:events` | Programs, activities, community events |

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
| `cip:governance` | Rules, policies, processes |
| `cip:structural` | Channels, roles, team changes |
| `cip:tooling` | Bots, automation, integrations |
| `cip:events` | Programs, activities, community events |
| `CIP Type: Governance` | Rules, policies, processes |
| `CIP Type: Structural` | Channels, roles, team changes |
| `CIP Type: Tooling` | Bots, automation, integrations |
| `CIP Type: Events` | Programs, activities, community events |
| `CIP Type: Other` | Anything that doesn't fit in another category |

For human-used labels, I like having this format

Comment thread rfcs/README.md

1. **Pitch:** Open an [RFCIP issue](https://github.com/openclaw/community/issues/new?template=rfcip.yml) describing the problem and your proposed direction.
2. **Champion:** Staff reviews the RFCIP and assigns a champion (staff sponsor and advocate). The champion assigns the next available CIP number.
3. **Draft:** Once greenlit, open a pull request adding `rfcs/XXXX-slug.md` (where `XXXX` is the PR number). Use [`0003-rfcip-template.md`](0003-rfcip-template.md) as your starting template.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
3. **Draft:** Once greenlit, open a pull request adding `rfcs/XXXX-slug.md` (where `XXXX` is the PR number). Use [`0003-rfcip-template.md`](0003-rfcip-template.md) as your starting template.
3. **Draft:** Once greenlit, open a pull request adding `rfcs/XXXX-slug.md` (where `XXXX` is the PR number). Use [`XXXX-cip-blank-template.md`](XXXX-cip-blank-template.md) as your starting template.

Comment on lines +295 to +297
## AI Disclosure

AI tools (Claude) were used as a collaborative partner in designing the CIP process structure, drafting this document, and generating the RFCIP issue template. All design decisions were made by the author through a structured questionnaire process.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Big fan of this section, thank you

## Implementation Plan

1. **Merge this CIP** into the `rfcs/` directory as the foundational process document.
2. **Create GitHub labels**: `cip:draft`, `cip:discussion`, `cip:accepted`, `cip:rejected`, `cip:governance`, `cip:structural`, `cip:tooling`, `cip:events`.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Would prefer a different format for these, I noted that on the rfcs/README.md file

Comment on lines +119 to +168
### Process Flow

```
Community member
┌─────────────┐
│ Open RFCIP │ ◀── GitHub issue using RFCIP template
│ issue │
└──────┬──────┘
┌─────────────┐
│ Staff review│ ◀── Staff evaluates the pitch
│ + assign │
│ champion │
└──────┬──────┘
┌─────────────┐
│ Champion │ ◀── Champion greenlights + assigns CIP number
│ greenlights │
└──────┬──────┘
┌─────────────┐
│ Open CIP PR │ ◀── PR adding rfcs/XXXX-slug.md
│ (Draft) │
└──────┬──────┘
┌─────────────┐
│ Discussion │ ◀── 7-day minimum; GitHub + Discord
│ period │
└──────┬──────┘
┌─────────────┐
│ Admin │
│ decision │
└──┬──────┬───┘
│ │
▼ ▼
Accepted Rejected
(merge) (close + rationale)
Tracking issue
opened
```

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Use mermaid for this!

Comment on lines +109 to +111
```
Draft ──▶ Discussion ──▶ Accepted
└──▶ Rejected

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Use mermaid for this!

Suggested change
```
Draft ──▶ Discussion ──▶ Accepted
└──▶ Rejected
```mermaid
flowchart LR
draft([Draft]) --> disc([Discussion])
disc --> a([Accepted])
disc --> r([Rejected])
flowchart LR
    draft([Draft]) --> disc([Discussion])
    disc --> a([Accepted])
    disc --> r([Rejected])
Loading

Comment on lines +204 to +222
### GitHub Labels

**Status labels** track lifecycle state:

| Label | Meaning |
| ---------------- | -------------------------------------- |
| `cip:draft` | Initial RFCIP or early CIP PR |
| `cip:discussion` | Under active community review |
| `cip:accepted` | Approved by Admin, PR merged |
| `cip:rejected` | Not approved |

**Type labels** categorize proposals:

| Label | Meaning |
| ----------------- | ------------------------------------- |
| `cip:governance` | Rules, policies, processes |
| `cip:structural` | Channels, roles, team changes |
| `cip:tooling` | Bots, automation, integrations |
| `cip:events` | Programs, activities, community events|

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Added preferred label names on rfc/README.md

@clawsweeper clawsweeper Bot added rating: 🧂 unranked krab Not merge-ready due to missing proof or serious correctness/safety concerns. status: 📣 needs proof The PR needs real behavior proof before ClawSweeper can clear the contributor ask. P3 Low-risk cleanup, docs, polish, ergonomics, or speculative feature. labels May 22, 2026
@clawsweeper

clawsweeper Bot commented May 22, 2026

Copy link
Copy Markdown

Codex review: needs real behavior proof before merge.

Workflow note: Future ClawSweeper reviews update this same comment in place.

How this review workflow works
  • ClawSweeper keeps one durable marker-backed review comment per issue or PR.
  • Re-runs edit this comment so the latest verdict, findings, and automation markers stay together instead of adding duplicate bot comments.
  • A fresh review can be triggered by eligible @clawsweeper re-review comments, exact-item GitHub events, scheduled/background review runs, or manual workflow dispatch.
  • PR/issue authors and users with repository write access can comment @clawsweeper re-review or @clawsweeper re-run on an open PR or issue to request a fresh review only.
  • Maintainers can also comment @clawsweeper review to request a fresh review only.
  • Fresh-review commands do not start repair, autofix, rebase, CI repair, or automerge.
  • Maintainer-only repair and merge flows require explicit commands such as @clawsweeper autofix, @clawsweeper automerge, @clawsweeper fix ci, or @clawsweeper address review.
  • Maintainers can comment @clawsweeper explain to ask for more context, or @clawsweeper stop to stop active automation.

Summary
The PR adds a CIP/RFCIP governance process, a GitHub RFCIP issue template, an rfcs/ README, a blank CIP template, and CIP label guidance.

Reproducibility: not applicable. as a runtime bug, but the PR defects are high-confidence from source inspection: the proposed files contain ASCII diagrams where Mermaid is required and inconsistent CIP numbering/template instructions.

PR rating
Overall: 🧂 unranked krab
Proof: 🧂 unranked krab
Patch quality: 🦐 gold shrimp
Summary: The proposal is coherent but not quality-ready because real behavior proof is missing and the patch has concrete docs/process correctness blockers.

Rank-up moves:

  • Add a screenshot, recording, copied live output, or other redacted proof showing the RFCIP issue form rendered in GitHub.
  • Convert both ASCII diagrams in rfcs/0003-rfcip-template.md to Mermaid.
  • Make numbering/template instructions consistent and resolve the label-name review comments.
What the crustacean ranks mean
  • 🦀 challenger crab: rare, exceptional readiness with strong proof, clean implementation, and convincing validation.
  • 🦞 diamond lobster: very strong readiness with only minor maintainer review expected.
  • 🐚 platinum hermit: good normal PR, likely mergeable with ordinary maintainer review.
  • 🦐 gold shrimp: useful signal, but proof or patch confidence is still limited.
  • 🦪 silver shellfish: thin signal; proof, validation, or implementation needs work.
  • 🧂 unranked krab: not merge-ready because proof is missing/unusable or there are serious correctness or safety concerns.
  • 🌊 off-meta tidepool: rating does not apply to this item.

Shiny media proof means a screenshot, video, or linked artifact directly shows the changed behavior. Runtime, network, CSP, and security claims still need visible diagnostics.

Real behavior proof
Needs real behavior proof before merge: The PR body/comments contain no screenshot, recording, terminal/live output, or rendered GitHub issue-form proof; add redacted proof to the PR body so ClawSweeper can re-review automatically, or ask a maintainer to comment @clawsweeper re-review if it does not.

Risk before merge

  • The PR still has a MEMBER changes-requested review covering Mermaid conversion and label-name preferences.
  • The new issue form and CIP lifecycle depend on labels plus staff/Admin workflow decisions that should be confirmed before merge.

Maintainer options:

  1. Decide the mitigation before merge
    Revise this PR so the process docs use Mermaid diagrams, the numbering and starter-template instructions are consistent, label/process choices match maintainer direction, and the RFCIP issue form is shown rendering correctly before landing it as the implementation path for the related community-improvement request.
  2. Pause or close
    Do not merge this PR until maintainers decide whether the risk is worth taking.

Next step before merge
Contributor proof is missing and the remaining governance choices need maintainer review; automation should not be queued because it cannot prove the contributor's GitHub issue-form setup.

Security
Cleared: The diff adds Markdown governance docs and a GitHub issue template; I found no concrete security or supply-chain regression.

Review findings

  • [P2] Use Mermaid for the CIP diagrams — rfcs/0003-rfcip-template.md:109-112
  • [P2] Fix the draft-step template and numbering guidance — rfcs/README.md:9
Review details

Best possible solution:

Revise this PR so the process docs use Mermaid diagrams, the numbering and starter-template instructions are consistent, label/process choices match maintainer direction, and the RFCIP issue form is shown rendering correctly before landing it as the implementation path for the related community-improvement request.

Do we have a high-confidence way to reproduce the issue?

Not applicable as a runtime bug, but the PR defects are high-confidence from source inspection: the proposed files contain ASCII diagrams where Mermaid is required and inconsistent CIP numbering/template instructions.

Is this the best way to solve the issue?

No as proposed; the broad CIP process may be useful, but the narrow maintainable path is to fix the Mermaid and guidance issues, then have maintainers settle the governance label/process choices before merge.

Label changes:

  • add P3: This is a low-risk governance and repository-template proposal with docs/process blockers rather than an urgent runtime failure.
  • add rating: 🧂 unranked krab: Current PR rating is 🧂 unranked krab because proof is 🧂 unranked krab, patch quality is 🦐 gold shrimp, and The proposal is coherent but not quality-ready because real behavior proof is missing and the patch has concrete docs/process correctness blockers.
  • add status: 📣 needs proof: The PR needs real behavior proof before ClawSweeper can clear the contributor ask. Needs real behavior proof before merge: The PR body/comments contain no screenshot, recording, terminal/live output, or rendered GitHub issue-form proof; add redacted proof to the PR body so ClawSweeper can re-review automatically, or ask a maintainer to comment @clawsweeper re-review if it does not.

Label justifications:

  • P3: This is a low-risk governance and repository-template proposal with docs/process blockers rather than an urgent runtime failure.
  • rating: 🧂 unranked krab: Current PR rating is 🧂 unranked krab because proof is 🧂 unranked krab, patch quality is 🦐 gold shrimp, and The proposal is coherent but not quality-ready because real behavior proof is missing and the patch has concrete docs/process correctness blockers.
  • status: 📣 needs proof: The PR needs real behavior proof before ClawSweeper can clear the contributor ask. Needs real behavior proof before merge: The PR body/comments contain no screenshot, recording, terminal/live output, or rendered GitHub issue-form proof; add redacted proof to the PR body so ClawSweeper can re-review automatically, or ask a maintainer to comment @clawsweeper re-review if it does not.

Full review comments:

  • [P2] Use Mermaid for the CIP diagrams — rfcs/0003-rfcip-template.md:109-112
    AGENTS.md requires every chart or diagram to use Mermaid, but this new lifecycle diagram is a plain fenced ASCII diagram; the larger process-flow diagram below follows the same pattern and already has a changes-requested review. Please convert these diagrams to mermaid fences before landing the process doc.
    Confidence: 0.96
  • [P2] Fix the draft-step template and numbering guidance — rfcs/README.md:9
    This draft step says XXXX is the PR number and tells authors to start from 0003-rfcip-template.md, but the same README later says numbers are assigned sequentially by the champion and the PR adds XXXX-cip-blank-template.md for authors to copy. That conflict will send future authors to the wrong file and naming rule.
    Confidence: 0.91

Overall correctness: patch is incorrect
Overall confidence: 0.91

What I checked:

Likely related people:

  • Shadow: Git history shows Shadow authored the existing issue templates, the Mermaid instruction, and recent community staff/process documentation touched by this proposal. (role: current issue-template and community-docs owner; confidence: high; commits: 85dd57f086aa, 57a1fc03d05e, dc67fb04f8e3; files: .github/ISSUE_TEMPLATE/config.yml, .github/ISSUE_TEMPLATE/policy-change.yml, .github/ISSUE_TEMPLATE/rules-change.yml)
  • thewilloftheshadow: The GitHub discussion on the related issue and the changes-requested review on this PR provide direct guidance on the RFCIP process, label naming, and Mermaid diagrams. (role: active reviewer and process feedback owner; confidence: medium; files: rfcs/README.md, rfcs/0003-rfcip-template.md, .github/ISSUE_TEMPLATE/rfcip.yml)

Codex review notes: model gpt-5.5, reasoning high; reviewed against bd2eda8e70c3.

@clawsweeper

clawsweeper Bot commented May 22, 2026

Copy link
Copy Markdown

ClawSweeper PR egg

🎁 Pass real behavior proof to wake the egg and unlock a hatchable treat.

Where did the egg go?
  • The egg game starts only after the PR passes the real-behavior proof check.
  • Before that, no creature or rarity is rolled. The treat waits for real proof.
  • This is still just collectible flavor: proof affects review readiness, not creature quality.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

P3 Low-risk cleanup, docs, polish, ergonomics, or speculative feature. rating: 🧂 unranked krab Not merge-ready due to missing proof or serious correctness/safety concerns. status: 📣 needs proof The PR needs real behavior proof before ClawSweeper can clear the contributor ask.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants