Skip to content

Commit 842ace0

Browse files
authored
Update issue templates with testing template
Add testing template
1 parent e62c8e8 commit 842ace0

File tree

1 file changed

+82
-0
lines changed

1 file changed

+82
-0
lines changed
Lines changed: 82 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,82 @@
1+
---
2+
name: Testing (bug, unit, manual. or new test)
3+
about: Add or improve unit tests, integration tests, or perform manual testing
4+
title: "[Test]: "
5+
labels: testing, triage
6+
assignees: ''
7+
8+
---
9+
10+
### ✅ Test Summary
11+
Briefly describe what needs to be tested or validated.
12+
13+
---
14+
15+
### 🧪 Test Type
16+
Choose one or more applicable categories:
17+
18+
- [ ] Unit tests (Python)
19+
- [ ] Integration / end-to-end tests
20+
- [ ] Manual UI testing (admin panel)
21+
- [ ] Transport coverage (HTTP, WebSocket, SSE, stdio)
22+
- [ ] Federation / multi-gateway testing
23+
- [ ] Configuration / environment-specific behavior
24+
- [ ] Other (explain below)
25+
26+
---
27+
28+
### 🧬 Scope & Affected Components
29+
Select what this test covers or validates:
30+
31+
- [ ] `mcpgateway` core (API logic, handlers)
32+
- [ ] Admin UI (HTMX / Alpine / Tailwind)
33+
- [ ] Tool/Resource/Prompt logic
34+
- [ ] Federation sync/discovery
35+
- [ ] Server interactions or SSE
36+
- [ ] Auth / JWT / security flows
37+
- [ ] Observability (logging, metrics)
38+
- [ ] Makefile, shell scripts or CLI
39+
- [ ] Containerized setup (Docker/Podman)
40+
- [ ] Other (explain below)
41+
42+
---
43+
44+
### 📋 Acceptance Criteria
45+
What should pass or be verified?
46+
47+
- [ ] All relevant assertions are covered
48+
- [ ] No side-effects or regressions observed
49+
- [ ] Confirmed in multiple environments (if needed)
50+
- [ ] Edge cases and error handling tested
51+
- [ ] Logs and output are clean and expected
52+
53+
---
54+
55+
### 📓 Notes & Steps
56+
Include commands, expected behaviors, or test strategy.
57+
58+
```bash
59+
# Example: run coverage locally
60+
make test coverage
61+
pytest tests/test_example.py
62+
```
63+
64+
---
65+
66+
### 🧠 Environment Info (if manual testing)
67+
68+
| Key | Value |
69+
| ---------------- | ---------------------------- |
70+
| Gateway version | `e.g. main@a1b2c3d` |
71+
| Python version | `e.g. 3.11` |
72+
| Transport tested | `http`, `ws`, `sse`, `stdio` |
73+
| OS / Platform | `e.g. macOS, Ubuntu` |
74+
| Container | `e.g. Docker, Podman, none` |
75+
76+
> If applicable (ex: new type of test) add information on how to set this up using CI/CD with GitHub Actions or contribute directly to the workflow in `.github/workflows`
77+
78+
---
79+
80+
### 📎 Related PRs / Issues (optional)
81+
82+
Link any relevant work.

0 commit comments

Comments
 (0)