Skip to content

Commit 6aa81cb

Browse files
committed
docs: update README & ISSUE_TEMPLATE/general.md for v2 multi-agent system
1 parent 06ba475 commit 6aa81cb

File tree

3 files changed

+360
-367
lines changed

3 files changed

+360
-367
lines changed

.github/ISSUES_TEMPLATE/ISSUES_TEMPLATE.md

Lines changed: 0 additions & 156 deletions
This file was deleted.

.github/ISSUE_TEMPLATE/general.md

Lines changed: 185 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,185 @@
1+
---
2+
name: 🧠 General Issue
3+
about: Use this for complex, cross-system, or unclear issues
4+
title: "[GENERAL] "
5+
labels: discussion
6+
---
7+
8+
> ⚠️ Use this template only if none of the other templates (bug, feature, MCP) fit your issue.
9+
10+
# 🧠 General Issue — Local MCP Memory Server
11+
12+
Thanks for taking the time to report an issue or suggest an improvement 🚀
13+
14+
This template is designed for:
15+
- complex problems
16+
- cross-system issues (memory + tasks + agents)
17+
- unclear or exploratory discussions
18+
19+
---
20+
21+
## 📌 Issue Type
22+
23+
Select one:
24+
25+
- [ ] 🐛 Bug (complex / unclear)
26+
- [ ] ✨ Feature (multi-system)
27+
- [ ] ⚡ Performance
28+
- [ ] 🧠 MCP / Agent Behavior
29+
- [ ] 🏗 Architecture / Design
30+
- [ ] ❓ Question / Discussion
31+
32+
---
33+
34+
## 📝 Description
35+
36+
Provide a clear explanation of the situation:
37+
38+
```txt
39+
What is happening?
40+
What are you trying to achieve?
41+
Why is this important?
42+
````
43+
44+
---
45+
46+
## 🎯 Expected Outcome
47+
48+
What should ideally happen?
49+
50+
```txt
51+
Describe the desired system behavior
52+
```
53+
54+
---
55+
56+
## ❗ Current Behavior (if applicable)
57+
58+
```txt
59+
What is actually happening?
60+
Include errors, inconsistencies, or unexpected results
61+
```
62+
63+
---
64+
65+
## 🧩 System Scope (IMPORTANT)
66+
67+
Which parts of the system are involved?
68+
69+
* [ ] Memory system
70+
* [ ] Task system
71+
* [ ] Agent system
72+
* [ ] Messaging system
73+
* [ ] Project Map
74+
* [ ] MCP protocol
75+
* [ ] Other:
76+
77+
---
78+
79+
## 🧠 MCP Context
80+
81+
* Agent:
82+
* MCP tools involved:
83+
* Was `get_agent_instructions` used? (Yes/No)
84+
* Memory server running? (Yes/No)
85+
* Any MCP errors:
86+
87+
---
88+
89+
## 🔄 Workflow Context (v2+)
90+
91+
If applicable:
92+
93+
* Were tasks involved? (Yes/No)
94+
* Were messages involved? (Yes/No)
95+
* Was there coordination between agents?
96+
* Any duplication or conflict observed?
97+
98+
---
99+
100+
## 🔁 Steps / Scenario (if reproducible)
101+
102+
```txt
103+
Describe the sequence of actions or scenario
104+
```
105+
106+
---
107+
108+
## 📦 Environment
109+
110+
* OS: (Windows / Linux / macOS)
111+
* Node.js:
112+
* MongoDB:
113+
* Project (MCP_PROJECT / folder name):
114+
* Running via:
115+
116+
* [ ] Codex
117+
* [ ] Roo
118+
* [ ] CLI
119+
* [ ] Other
120+
121+
---
122+
123+
## 📄 Logs / Error Output
124+
125+
```bash
126+
(paste logs here)
127+
```
128+
129+
---
130+
131+
## 📂 Affected Areas / Files
132+
133+
```txt
134+
List modules, files, or systems involved
135+
```
136+
137+
---
138+
139+
## 💡 Thoughts / Hypothesis (Optional)
140+
141+
```txt
142+
What do you think might be causing this?
143+
Any ideas for improvement?
144+
```
145+
146+
---
147+
148+
## 🧠 Additional Context
149+
150+
* screenshots
151+
* architecture notes
152+
* related issues
153+
* prior attempts
154+
155+
---
156+
157+
## 🔍 Checklist
158+
159+
* [ ] I checked existing issues
160+
* [ ] I provided enough context
161+
* [ ] I included logs (if applicable)
162+
* [ ] I understand MCP requires clean stdout
163+
* [ ] This does not fit other templates
164+
165+
---
166+
167+
## 🤝 Contribution (Optional)
168+
169+
* [ ] I can work on this
170+
* [ ] I need guidance
171+
* [ ] Just reporting
172+
173+
---
174+
175+
## 🧠 Final Note
176+
177+
This project is evolving into a **multi-agent system platform**.
178+
179+
Issues like this help improve:
180+
181+
* coordination between agents
182+
* system reliability
183+
* shared intelligence
184+
185+
Thanks for contributing 💙

0 commit comments

Comments
 (0)