Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
202 changes: 202 additions & 0 deletions CONTRIBUTING_EN-googletrans.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,202 @@
∏# 🤝 Participate and contribute

<p align="center">
<strong>Three provinces and six ministries welcome heroes from all walks of life ⚔️</strong><br>
<sub>Whether it’s fixing a typo or designing a new Agent character, we’re all very grateful</sub>
</p>

---

## 📋 How to contribute

### 🐛 Report a bug

Please use the [Bug Report](.github/ISSUE_TEMPLATE/bug_report.md) template to submit an Issue, including:
- OpenClaw version (`openclaw --version`)
- Python version (`python3 --version`)
- operating system
- Steps to reproduce (the more detailed, the better)
- Desired behavior vs actual behavior
- Screenshots (if Kanban UI is involved)

### 💡 Feature Suggestions

Use the [Feature Request](.github/ISSUE_TEMPLATE/feature_request.md) template.

We recommend using the "will" format to describe your needs - just like writing a memorial to the emperor 😄

### 🔧 Submit Pull Request

```bash
# 1. Fork this warehouse
# 2. Clone your Fork
git clone https://github.com/<your-username>/edict.git
cd edict

# 3. Create a feature branch
git checkout -b feat/my-awesome-feature

# 4. Development & Testing
python3 dashboard/server.py # 启动看板验证

# 5. Submit
git add .
git commit -m "feat: 添加了一个很酷的功能"

# 6. Push & create PR
git push origin feat/my-awesome-feature
```

---

## 🏗️ Development environment

### Preconditions
- [OpenClaw](https://openclaw.ai) installed
-Python 3.9+
- macOS/Linux

### Local startup

```bash
# Install
./install.sh

# Start data refresh (running in the background)
bash scripts/run_loop.sh &

# Start the kanban server
python3 dashboard/server.py

# Open browser
open http://127.0.0.1:7891
```

> 💡 **Kanbanboard out of the box**: `server.py` embeds `dashboard/dashboard.html`, Docker image includes pre-built React frontend

### Quick overview of project structure

| Directory/File | Description | Frequency of changes |
|----------|------|--------|
| `dashboard/dashboard.html` | Kanban front-end (single file, zero dependencies, ready to use out of the box) | 🔥 High |
| `dashboard/server.py` | API Server (stdlib, ~2200 lines) | 🔥 High |
| `agents/*/SOUL.md` | 12 Agent personality templates | 🔶 Medium |
| `scripts/kanban_update.py` | Kanban CLI + data cleaning (~300 lines) | 🔶 Medium |
| `scripts/*.py` | Data synchronization / automation script | 🔶 Medium |
| `tests/test_e2e_kanban.py` | E2E Kanban test (17 assertions) | 🔶 Medium |
| `install.sh` | Installation script | 🟢 Low |

---

## 📝 Commit specification

We use [Conventional Commits](https://www.conventionalcommits.org/):

```
feat: ✨ NEW FEATURES
fix: 🐛 Fix Bug
docs: 📝 Documentation update
style: 🎨 code format (does not affect logic)
refactor: ♻️ code refactoring
perf: ⚡ performance optimization
test: ✅ test
chore: 🔧 Miscellaneous maintenance
ci: 👷 CI/CD configuration
```

Example:
```
feat: Added the function of exporting memorials to PDF
fix: Fixed the problem of Gateway not restarting after model switching
docs: Updated README screenshots
```

---

## 🎯 Specially welcome contributions

### 🎨 Kanban UI
- Dark/light theme switching
- Responsive layout optimization
- Enhanced animation effects
- Accessibility (a11y) improvements

### 🤖 New Agent role
- Full-time Agent suitable for specific industries/scenarios
- New SOUL.md personality template
- Innovation in collaboration model between agents

### 📦 Skills Ecosystem
- Dedicated skill packages for each department
- MCP integration skills
- Special skills in data processing/code analysis/document generation

### 🔗 Third-party integration
- Notion / Jira / Linear synchronization
- GitHub Issues/PR linkage
- Slack / Discord messaging channels
- Webhook extension

### 🌐 Internationalization
- Japanese / Korean / Spanish translation
- Kanban UI multi-language support

### 📱 Mobile version
- Responsive adaptation
- PWA support
- Mobile operation optimization

---

## 🧪 Test

```bash
# Compilation check
python3 -m py_compile dashboard/server.py
python3 -m py_compile scripts/kanban_update.py

# E2E Kanban Test (9 Scenario 17 Assertion)
python3 tests/test_e2e_kanban.py

# Verify data synchronization
python3 scripts/refresh_live_data.py
python3 scripts/sync_agent_config.py

# Start server verification API
python3 dashboard/server.py &
curl -s http://localhost:7891/api/live-status | python3 -m json.tool | head -20
```

---

## 📏 Code style

- **Python**: PEP 8, use pathlib to handle paths
- **TypeScript/React**: Function components + Hooks, CSS variable names start with `--`
- **CSS**: Use CSS variables (`--bg`, `--text`, `--acc`, etc.), BEM-style class names
- **Markdown**: Use `#` for titles, `-` for lists, code block annotation language

---

## 🙏 Code of Conduct

- Be kind and constructive
- Respect different perspectives and experiences
- Accept constructive criticism
- Focus on what is best for the community
- Show empathy towards other community members

**We have zero tolerance for harassment. **

---

## 📬 Contact information

- GitHub Issues: [Submit an issue](https://github.com/cft0808/edict/issues)
- GitHub Discussions: [Community Discussions](https://github.com/cft0808/edict/discussions)

---

<p align="center">
<sub>Thank you to every contributor, you are the cornerstone of the three provinces and six departments ⚔️</sub>
</p>
106 changes: 106 additions & 0 deletions ROADMAP_EN-googletrans.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,106 @@
# 🗺️ Three provinces and six departments · Roadmap

> This roadmap is public. Welcome to claim unfinished projects and submit PRs to participate in the construction.
>
> How to claim: Reply "I'll take this" under the corresponding issue, or submit a PR directly and indicate it in the description.

---

## Phase 1 — Core Architecture ✅

> The skeleton of three provinces and six departments: twelve departments + prince sorting + real-time billboard + complete workflow.

- [x] Twelve-department Agent structure (Prince + Zhongshu·Menxia·Shangshu + Huli Bingxinggong + Officials + Early Dynasty Officials)
- [x] Prince Sorting Layer - Automatically identify chats/commands, reply directly to chats, extract the title of the command and transfer it to Zhongshu Province
- [x] Strict permission matrix - who can send messages to whom, in black and white
- [x] Military Aircraft Department real-time dashboard (10 function panels)
- [x] Task life cycle management (create → sort → plan → review → dispatch → execute → echo)
- [x] Task pause/cancel/resume
- [x] Memorial system (automatic archiving of completed decrees + five-stage timeline)
- [x] Imperial edict template library (9 preset templates + parameter form + estimated time/cost)
- [x] A sense of ritual for going to court (the opening animation will be played for the first time every day + today’s statistics)
- [x] World News (daily automatic collection of technology/financial information + Feishu push + subscription management)
- [x] Model hot switching (one-click switching of each Agent's LLM in the dashboard)
- [x] Skill management (check installed Skills in each province + add new skills)
- [x] Official overview (Token consumption ranking + activity + completion statistics)
- [x] Small tasks/session monitoring (OC-* session real-time tracking)
- [x] Purpose data cleaning - titles/notes are automatically purified, and dirty data is refused to be stored in the database
- [x] Duplicate mission protection - Completed/cancelled missions cannot be overwritten
- [x] E2E Kanban test (all 9 scenarios and 17 assertions passed)
- [x] React 18 front-end refactoring - TypeScript + Vite + Zustand, 13 functional components
- [x] Visualization of Agent's thinking process - real-time display of thinking / tool_result / user messages
- [x] Integrated front-end and back-end deployment - server.py also provides API + static file services

---

## Phase 2 — System deepening 🚧

> Upgrade "easy to use" to "irreplaceable": Decentralization and checks and balances are not just a concept, but a complete system with performance evaluation, manual approval, and knowledge accumulation.

### 🏅 Royal approval mode (manual approval node)
- [ ] The results of the deliberation of the province are submitted to "Yulan", which can be accurately read/rejected manually with one click.
- [ ] Approval panel within the Kanban board (pending approval list + historical approval instructions)
- [ ] Feishu/Telegram push approval notification
- **Difficulty**: ⭐⭐ | **Suitable for first time contributors**

### 📊 Record of Merits and Demerits (Agent Performance Rating System)
- [ ] Completion rate, rework rate, and time-consuming statistics of each Agent
- [ ] Kanban panel display ranking list + trend chart
- [ ] Automatically mark "competent ministers" and "Agents who need training"
- **Difficulty**: ⭐⭐

### 🚀 Express Shop (visualization of real-time message flow between agents)
- [ ] Real-time connection animation in the billboard: Zhongshu → Menxia → Shangshu → Liubu
- [ ] Message type coloring (Dispatch/Consideration/Echo/Reject)
- [ ] Timeline playback mode
- **Difficulty**: ⭐⭐⭐

### 📚 National History Museum (knowledge base + citation tracing)
- [ ] The experience of historical will is automatically precipitated
- [ ] Similar intention search + recommendation
- [ ] Traceability chain of memorial citations
- **Difficulty**: ⭐⭐⭐

---

## Phase 3 — Ecological Expansion

> From stand-alone tools to ecosystem: more integrations, more users, and more scenarios.

### 🐳 Docker Compose + Demo Image
- [ ] `docker run` One-line command to experience the complete dashboard (preset simulation data)
- [ ] Docker Compose orchestration (kanban + data synchronization + OpenClaw Gateway)
- [ ] CI/CD automatically builds push images
- **Difficulty**: ⭐⭐ | **Suitable for first time contributors**

### 🔗 Kanban Adapter
- [ ] Notion Adapter - Turn the Notion database into a military aircraft department billboard
- [ ] Linear adapter - Linear projects are synchronized to three provinces and six departments
- [ ] GitHub Issues two-way synchronization
- **Difficulty**: ⭐⭐⭐

### 📱 Mobile + PWA
- [ ] Responsive layout adapted to mobile phones/tablets
- [ ] PWA offline support + push notifications
- **Difficulty**: ⭐⭐

### 🏪 ClawHub is available
- [ ] Core Skills submitted to OpenClaw official Skill Market
- [ ] Install three provinces and six Skill Packs with one click
- **Difficulty**: ⭐

### 📈 Annual exam
- [ ] Agent annual performance report (total Token consumption, completion rate, most complex intention)
- [ ] Visual annual review screen
- **Difficulty**: ⭐⭐

---

## How to participate

1. **Look at Phase 2** - These are the directions that need the most help right now
2. **Look for projects marked with ⭐⭐ or "Suitable for first time contribution"** to get started
3. **Open an Issue** to say what you want to do to avoid duplication of work
4. **Publish PR** - see [CONTRIBUTING.md](CONTRIBUTING.md) for details

> 💡 Didn’t find the direction you want to go? You are welcome to open an Issue to propose new features, and good ideas will be added to the Roadmap.
Loading