Skip to content

Commit 688bdb1

Browse files
author
螃蟹 🦀
committed
docs: overhaul README, upgrade issue/PR templates, add metadata suggestions
- Rewrite README with clean UTF-8 encoding (fix garbled Unicode) - Improve structure with navigation links and terminal preview - Add comparison table vs promptfoo, deepeval - Add roadmap section with completed and planned features - Upgrade issue templates with detailed sections and categories - Upgrade PR template with checklists and assertion/adapter categories - Add github-metadata-suggestions.md with SEO tags and description
1 parent 06c38dd commit 688bdb1

5 files changed

Lines changed: 262 additions & 130 deletions

File tree

Lines changed: 52 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,60 @@
11
---
2-
name: Bug Report
3-
about: Report a bug in AgentProbe
2+
name: 🐛 Bug Report
3+
about: Report a bug or unexpected behavior in AgentProbe
4+
title: "[Bug] "
45
labels: bug
6+
assignees: ''
57
---
68

7-
## Describe the bug
9+
## Description
810

9-
## To Reproduce
10-
1. ...
11+
A clear and concise description of the bug.
1112

12-
## Expected behavior
13+
## Steps to Reproduce
14+
15+
1. Install: `npm install @neuzhou/agentprobe`
16+
2. Create test file: `tests/example.test.yaml`
17+
3. Run: `npx agentprobe run tests/example.test.yaml`
18+
4. See error
19+
20+
## Expected Behavior
21+
22+
What you expected to happen.
23+
24+
## Actual Behavior
25+
26+
What actually happened. Include full error output.
27+
28+
## Test File
29+
30+
<details>
31+
<summary>Test YAML (if applicable)</summary>
32+
33+
```yaml
34+
Paste your test file here
35+
```
36+
37+
</details>
1338

1439
## Environment
15-
- OS:
16-
- Node:
17-
- AgentProbe version:
40+
41+
- **OS:** (e.g., macOS 14.2, Ubuntu 22.04, Windows 11)
42+
- **Node.js version:** (`node --version`)
43+
- **AgentProbe version:** (from `package.json`)
44+
- **Adapter:** (e.g., openai, anthropic, ollama)
45+
- **Model:** (e.g., gpt-4o, claude-sonnet-4-20250514)
46+
47+
## Error Output
48+
49+
<details>
50+
<summary>Full error output</summary>
51+
52+
```
53+
Paste error output here
54+
```
55+
56+
</details>
57+
58+
## Additional Context
59+
60+
Any other context about the problem.
Lines changed: 40 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,46 @@
11
---
2-
name: Feature Request
3-
about: Suggest a feature
2+
name: ✨ Feature Request
3+
about: Suggest a new feature or enhancement for AgentProbe
4+
title: "[Feature] "
45
labels: enhancement
6+
assignees: ''
57
---
68

7-
## Feature description
9+
## Problem Statement
810

9-
## Use case
11+
What problem does this feature solve? Is it related to an existing frustration?
1012

11-
## Proposed solution
13+
## Proposed Solution
14+
15+
A clear description of what you want to happen. Include YAML or code examples if applicable:
16+
17+
```yaml
18+
# Example test definition
19+
tests:
20+
- input: "..."
21+
expect:
22+
your_new_assertion: true
23+
```
24+
25+
## Use Case
26+
27+
Describe a concrete scenario where this feature would be useful.
28+
29+
## Category
30+
31+
- [ ] 🧪 New assertion type
32+
- [ ] 🔌 New adapter (LLM provider)
33+
- [ ] 🔒 Security testing
34+
- [ ] 📊 Reporting / output format
35+
- [ ] 🤖 Multi-agent testing
36+
- [ ] 🔧 CLI improvement
37+
- [ ] 📝 Documentation
38+
- [ ] Other
39+
40+
## Alternatives Considered
41+
42+
What other approaches have you thought about?
43+
44+
## Additional Context
45+
46+
Any relevant examples, links, or references (e.g., testing frameworks, agent patterns).

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 42 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,46 @@
1-
## Description
1+
## Summary
2+
3+
Brief description of changes and motivation.
24

35
## Changes
46

7+
-
8+
9+
## Type of Change
10+
11+
- [ ] 🐛 Bug fix (non-breaking change that fixes an issue)
12+
- [ ] ✨ New feature (non-breaking change that adds functionality)
13+
- [ ] 🧪 New assertion type
14+
- [ ] 🔌 New adapter
15+
- [ ] 💥 Breaking change (fix or feature that would cause existing functionality to change)
16+
- [ ] 📝 Documentation update
17+
- [ ] ♻️ Refactor (no functional change)
18+
19+
## Testing
20+
21+
- [ ] All existing tests pass (`npm test`)
22+
- [ ] New tests added for new functionality
23+
- [ ] Linting passes
24+
- [ ] Manually tested with sample test suites
25+
526
## Checklist
6-
- [ ] Tests pass
7-
- [ ] Docs updated
27+
28+
- [ ] Code follows the project's TypeScript style guidelines
29+
- [ ] Self-review of own code completed
30+
- [ ] Documentation updated (if applicable)
31+
- [ ] Examples updated (if adding new features)
32+
33+
## Related Issues
34+
35+
Closes #
36+
37+
## Screenshots / Demo
38+
39+
<details>
40+
<summary>Test output or screenshots (if applicable)</summary>
41+
42+
```
43+
Paste here
44+
```
45+
46+
</details>

0 commit comments

Comments
 (0)