block/coplan

Dernière activité source enregistrée: 11 mars 2026 à 18:56

Catalogue SkillsMP mis à jour: 5 novembre 2026 à 19:57

skills collectés: 1

Étoiles GitHub: 40
Forks GitHub: 22

Installer avec un assistant IA

Copiez ce prompt dans l’assistant IA que vous utilisez.

Follow https://skillsmp.com/skill-install/prompt.md to install Agent Skills from https://github.com/block/coplan.

README du dépôt

Fichier source du README : README.md

Lire le README source

Afficher le README complet

# Coplan Engineering design doc review, purpose-built for AI-assisted planning. Built with Rails 8, Hotwire, and a semantic operations API. ## Why Coplan? Plans get better when more eyes see them. An engineer drafts a plan — often with AI help — and Coplan gives it a home where teammates can review it, leave inline feedback, and iterate. Domain experts catch things the author missed. AI agents respond to feedback and apply edits automatically. The result is higher-quality plans before a single line of code is written. **The editing model is intentionally asymmetric:** humans comment, AI agents edit. When a reviewer leaves feedback and the author accepts it, an agent applies the change — creating a new immutable version with full provenance (who changed what, why, and which comment triggered it). This keeps the version history clean and auditable. ## How It Works - **Plans are Markdown documents** that move through a lifecycle: `brainstorm → considering → developing → live` (or `→ abandoned`). Brainstorm plans are private; once a plan moves to *considering*, it's published to the whole org. - **Inline commenting** — select any text in the rendered plan to leave a comment, Google Docs-style. Comments are threaded and anchor to the selected text. - **AI agents edit via semantic operations** — `replace_exact`, `insert_under_heading`, `delete_paragraph_containing` — not brittle line numbers. Agents acquire an edit lease (one at a time), submit operations against a base revision, and the server creates a new version. - **Cloud Personas** — server-side AI reviewers (security, scalability, routing) that automatically review plans when they reach certain statuses, or on demand. - **Realtime** — comments, edits, and status changes broadcast instantly to all viewers via Turbo Streams. - **Full provenance** — every version records the actor (human, local agent, or cloud persona), the AI model used, the prompt, and which comments triggered the change. ## Tech Stack - **Ruby on Rails 8+** — importmaps, Hotwire, Stimulus - **MySQL 8+** — UUID primary keys - **SolidQueue** — background jobs - **SolidCable** — ActionCable adapter ## Installation Add to your Gemfile: ```ruby gem "coplan-engine", require: "coplan" ``` See the [Host App Integration Guide](./docs/HOST_APP_GUIDE.md) for full setup instructions. ### Optional integrations - [`coplan-slack`](./integrations/slack/README.md) adds signed Slack Events API handling and rich link unfurls without coupling Slack to the core engine. ## Development Setup ```bash bin/setup --skip-server bin/dev ``` Setup installs the shared, idempotent demo library. Sign in as **hampton@example.com** (no password in this example host), then open **[Demo library](http://localhost:3000/hampton/demo-library)**. It links to presentations, architecture diagrams, tables, code, and named review scenarios. Use **alex@example.com** for an approver/admin or **noura@example.com** for a security approver. To add missing examples to an existing development database: ```bash bin/rails coplan:demo:seed ``` The demo ships with the engine gem. It is separate from `coplan:seed`, which installs only required reference data and is safe in production. See the [demo library guide](docs/DEMO_LIBRARY.md) for scenarios, custom ports, and how to add examples. Re-seeding preserves document content, titles, approvals, and discussion state; use a fresh database when you need the initial states. For microphone dictation, start `bin/dev` from a shell with `OPENAI_API_KEY` set, or configure `openai.api_key` in Rails credentials. Both the plan microphone and the composer’s Dictate button then record audio for server transcription. If you add the key after starting the server, restart it and reload the plan. Without a key, dictation uses the browser’s speech service, which may be unavailable in embedded browsers. Check configuration without printing the key: ```bash bin/rails runner 'puts CoPlan::Ai.available?' ``` ## Tests ```bash bundle exec rspec ``` See [CONTRIBUTING.md](./CONTRIBUTING.md) for pull request, spec, and visual testing requirements. Interactive features are tested with JavaScript-enabled browser specs in `spec/system/`. ## API Agents authenticate with `Authorization: Bearer <token>`. Key endpoints: - `GET /api/v1/plans/:id` — read a plan - `POST /api/v1/plans/:id/lease` — acquire edit lease - `POST /api/v1/plans/:id/operations` — apply semantic edits - `POST /api/v1/plans/:id/comments` — comment on a plan See [docs/PLAN.md](./docs/PLAN.md) for full architecture. ## Project Resources | Resource | Description | |----------|-------------| | [CODEOWNERS](./CODEOWNERS) | Project lead(s) | | [GOVERNANCE.md](./GOVERNANCE.md) | Project governance | | [LICENSE](./LICENSE) | Apache License, Version 2.0 |

Chargement du README du dépôt…

Skills dans ce dépôt

Développeurs de logiciels

1 catégories métier · 100% classifié

skill

métier

description

mis à jour

releasing-coplan

Développeurs de logiciels

Publish the coplan-engine gem to RubyGems. Use when releasing a new version, publishing the gem, or bumping the version.

Langue du texte source : anglais

2026-03-11

Affichage de 1 skills collectés sur 1.