Skip to content

Commit 2a0cc04

Browse files
authored
Merge pull request #4 from alibrahim/release-prep
Release prep: CONTRIBUTING.md, CHANGELOG.md, repo topics
2 parents bf9826d + 4e71dfb commit 2a0cc04

File tree

2 files changed

+101
-0
lines changed

2 files changed

+101
-0
lines changed

CHANGELOG.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
# Changelog
2+
3+
## [1.0.0] - 2026-03-28
4+
5+
### Added
6+
- Cascade orchestrator agent with dependency-aware coordination
7+
- Cascade planner agent for impact analysis and step-by-step planning
8+
- Cascade worker agent with TDD support and mandatory commits
9+
- Cascade contracts agent for API contract sync and versioning
10+
- Cascade verifier agent for cross-service consistency checks
11+
- Parallel execution by dependency tiers
12+
- `/cascade-init` command for project setup
13+
- `/cascade-status` command for service health overview
14+
- Skills: multi-service-orchestration, contract-management, cross-service-verification
15+
- Food marketplace example with 6 services and 10 test changes
16+
- Demo GIFs: parallel execution + dependency propagation
17+
18+
### Tested
19+
- 24/24 on 12-change gauntlet (breaking renames, response restructuring, cross-cutting middleware)
20+
- Outperformed Agent Teams (17/24) and per-service sessions (7/24)
21+
- Verified on 3-service and 6-service projects

CONTRIBUTING.md

Lines changed: 80 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,80 @@
1+
# Contributing to Cascade
2+
3+
Thanks for your interest in contributing to Cascade. Here's how to get involved.
4+
5+
## Quick Start
6+
7+
1. Fork the repo
8+
2. Clone your fork
9+
3. Install the plugin locally:
10+
```
11+
/plugin marketplace add ./path/to/your/fork
12+
/plugin install cascade@cascade
13+
```
14+
4. Test against the food-marketplace example:
15+
```bash
16+
cd plugins/cascade/examples/food-marketplace
17+
/cascade-init
18+
"Add a phone field to users and propagate to all services"
19+
```
20+
21+
## What to Contribute
22+
23+
### High Impact
24+
- **New example projects** — different stacks (Node/Express, Go, mixed), different domains
25+
- **Bug reports with reproduction steps** — run a change, show what went wrong
26+
- **Agent prompt improvements** — if an agent misses something, improve its instructions
27+
28+
### Medium Impact
29+
- **New skills** — e.g., database migration coordination, API versioning strategies
30+
- **Stack-specific worker variants** — workers optimized for Go, Rust, Java projects
31+
- **Better verification checks** — more grep patterns, syntax validators per language
32+
33+
### Always Welcome
34+
- Documentation improvements
35+
- Typo fixes
36+
- Test cases for edge cases the agents miss
37+
38+
## Project Structure
39+
40+
```
41+
plugins/cascade/
42+
├── agents/ # Agent definitions (the core logic)
43+
│ ├── orchestrator.md
44+
│ ├── cascade-planner.md
45+
│ ├── cascade-worker.md
46+
│ ├── cascade-contracts.md
47+
│ └── cascade-verifier.md
48+
├── skills/ # Reusable knowledge
49+
├── commands/ # Slash commands (/cascade-init, /cascade-status)
50+
├── hooks/ # Lifecycle hooks
51+
└── examples/ # Demo projects
52+
```
53+
54+
## How Agents Work
55+
56+
Each agent is a Markdown file with YAML frontmatter. The frontmatter defines the agent's name, description, tools, and model. The body is the system prompt.
57+
58+
When modifying an agent:
59+
- Keep the description specific — Claude uses it to decide when to delegate
60+
- Test your changes against the food-marketplace example
61+
- Run at least one breaking rename (Change 3) and one parallel change (Change 7) to verify
62+
63+
## Pull Request Process
64+
65+
1. Create a branch from `main`
66+
2. Make your changes
67+
3. Test against the example project
68+
4. Open a PR with:
69+
- What you changed
70+
- Why
71+
- How you tested it
72+
5. Keep PRs focused — one change per PR
73+
74+
## Code of Conduct
75+
76+
Be kind. Be constructive. We're all here to build better tools.
77+
78+
## License
79+
80+
By contributing, you agree that your contributions will be licensed under the MIT License.

0 commit comments

Comments
 (0)