Skip to content
Merged
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
99 changes: 99 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,99 @@
---
name: 🐛 Bug Report
about: Create a report to help us improve
title: 'bug: '
labels: ['bug', 'needs-triage']
assignees: ''
---

# 🐛 Bug Report

## 📝 Description
<!-- A clear and concise description of what the bug is -->

## 🔄 Steps to Reproduce
1. Go to '...'
2. Click on '...'
3. Scroll down to '...'
4. See error

## ✅ Expected Behavior
<!-- A clear and concise description of what you expected to happen -->

## ❌ Actual Behavior
<!-- A clear and concise description of what actually happened -->

## 📱 Environment
<!-- Please complete the following information -->
- **OS**: [e.g., Ubuntu 22.04, macOS 13.0, Windows 11]
- **Node.js Version**: [e.g., 18.17.0, 20.5.0, 22.0.0]
- **Package Version**: [e.g., 0.6.0]
- **MCP Client**: [e.g., Claude Code, custom client]
- **Installation Method**: [e.g., npm install, git clone]

## 🖼 Screenshots/Logs
<!-- If applicable, add screenshots or log output to help explain your problem -->

### Error Logs
```
Paste relevant error logs here
```

### MCP Communication Logs
```
Paste MCP protocol logs if available
```

## 🧪 Minimal Reproduction
<!-- Please provide the smallest possible reproduction case -->

### Code Example
```typescript
// Minimal code that reproduces the issue
```

### Configuration
```json
{
"relevant": "configuration here"
}
```

## 🔍 Additional Context
<!-- Add any other context about the problem here -->

### Frequency
- [ ] Happens every time
- [ ] Happens sometimes
- [ ] Happened once

### Impact
- [ ] Blocks all functionality
- [ ] Blocks some functionality
- [ ] Cosmetic issue
- [ ] Performance issue

### Workaround
<!-- Is there a temporary workaround? -->
- [ ] No workaround found
- [ ] Workaround available (please describe below)

### Workaround Description
<!-- If you found a workaround, please describe it -->

## 🔧 Possible Solution
<!-- If you have ideas on how to fix this bug, please describe them -->

## 📋 Checklist
<!-- Please check all that apply -->
- [ ] I have searched existing issues to make sure this is not a duplicate
- [ ] I have provided all requested information
- [ ] I have tested with the latest version
- [ ] I have provided a minimal reproduction case
- [ ] I have included relevant logs/screenshots

## 🏷 Labels
<!-- The maintainers will add appropriate labels, but you can suggest them -->
Suggested labels: bug, needs-triage

<!-- If this is a security issue, please email instead of creating a public issue -->
204 changes: 204 additions & 0 deletions .github/ISSUE_TEMPLATE/documentation.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,204 @@
---
name: 📚 Documentation Issue
about: Report missing, incorrect, or unclear documentation
title: 'docs: '
labels: ['documentation', 'needs-triage']
assignees: ''
---

# 📚 Documentation Issue

## 📝 Issue Type
<!-- Mark the appropriate option with an 'x' -->
- [ ] 📝 Missing documentation
- [ ] 🐛 Incorrect documentation
- [ ] 🔍 Unclear/confusing documentation
- [ ] 🔗 Broken links
- [ ] 🌐 Translation needed
- [ ] ✨ Documentation enhancement
- [ ] 🧹 Outdated documentation

## 📍 Location
<!-- Where is the documentation issue located? -->
- **File**: [e.g., README.md, PROTOCOL.md, docs/api.md]
- **Section**: [e.g., Installation, API Reference, Examples]
- **URL**: [e.g., https://github.com/jerfowler/agent-comm-mcp-server#installation]

## 🔍 Current State
<!-- What is currently documented (if anything)? -->
<!-- Include relevant quotes from the current documentation -->

### Current Documentation
```markdown
<!-- Paste the current documentation here -->
```

## ❌ Problem Description
<!-- What is wrong, missing, or unclear? -->
<!-- Be as specific as possible -->

### Specific Issues
- [ ] Information is completely missing
- [ ] Information is outdated
- [ ] Examples don't work
- [ ] Steps are unclear
- [ ] Technical details are incorrect
- [ ] Links are broken
- [ ] Formatting is broken
- [ ] Code snippets have errors

### Impact
- [ ] Prevents users from getting started
- [ ] Causes confusion during development
- [ ] Leads to incorrect implementation
- [ ] Makes troubleshooting difficult
- [ ] Affects API usage

## ✅ Expected Documentation
<!-- What should the documentation say/include? -->

### Proposed Content
```markdown
<!-- Your suggested documentation content -->
```

### Required Information
<!-- What specific information needs to be included? -->
- [ ] Clear step-by-step instructions
- [ ] Working code examples
- [ ] Error handling examples
- [ ] Configuration options
- [ ] Troubleshooting section
- [ ] API reference
- [ ] Best practices

## 🎯 Target Audience
<!-- Who is this documentation for? -->
- [ ] New users/getting started
- [ ] Developers integrating the package
- [ ] Contributors to the project
- [ ] MCP protocol implementers
- [ ] Advanced users/power users

## 🌍 Context
<!-- Additional context that helps understand the issue -->

### User Journey
<!-- What is the user trying to accomplish? -->
1. User wants to...
2. User goes to...
3. User expects to find...
4. But instead finds...

### Related Functionality
<!-- What features/APIs are related to this documentation? -->

### Dependencies/Prerequisites
<!-- What should users know before reading this documentation? -->

## 💡 Suggested Solutions
<!-- If you have ideas for how to fix this -->

### Content Improvements
<!-- Specific content suggestions -->

### Structural Changes
<!-- Changes to organization/layout -->

### Additional Resources
<!-- Links, examples, or references that would help -->

## 📸 Screenshots/Examples
<!-- If applicable, add screenshots showing the problem -->
<!-- Or examples of good documentation from similar projects -->

### Current State
<!-- Screenshot/example of current documentation -->

### Desired State
<!-- Screenshot/example of how it should look -->

## 🔗 Related Issues
<!-- Link any related issues or pull requests -->
- Related to #
- Fixes #
- Depends on #

## 📋 Documentation Checklist
<!-- For comprehensive documentation improvements -->

### Content Quality
- [ ] Clear and concise language
- [ ] Accurate technical information
- [ ] Up-to-date examples
- [ ] Proper grammar/spelling
- [ ] Consistent terminology

### Structure
- [ ] Logical organization
- [ ] Proper headings/sections
- [ ] Table of contents (if needed)
- [ ] Cross-references
- [ ] Navigation elements

### Examples
- [ ] Working code examples
- [ ] Real-world use cases
- [ ] Error handling examples
- [ ] Configuration examples
- [ ] Integration examples

### Accessibility
- [ ] Alt text for images
- [ ] Descriptive link text
- [ ] Proper markdown formatting
- [ ] Screen reader friendly
- [ ] Multiple format support

## 🤝 Contribution
<!-- Are you willing to help improve this documentation? -->
- [ ] I can write the missing documentation
- [ ] I can review/edit existing content
- [ ] I can provide examples/use cases
- [ ] I can test documentation accuracy
- [ ] I'm unable to contribute directly

## 📚 Reference Materials
<!-- Links to helpful resources -->

### Official Documentation
<!-- Links to MCP protocol docs, Node.js docs, etc. -->

### Similar Projects
<!-- Examples from other projects with good documentation -->

### Style Guides
<!-- Documentation style references -->

## 🔧 Technical Details
<!-- If the issue involves code examples or API docs -->

### Environment
- **Node.js Version**: [e.g., 18.17.0]
- **Package Version**: [e.g., 0.6.0]
- **Operating System**: [e.g., Ubuntu 22.04]

### Code Context
```typescript
// Relevant code that needs documentation
```

## 📝 Additional Notes
<!-- Any other information that might be helpful -->

## 📋 Final Checklist
- [ ] I have searched existing issues for similar documentation requests
- [ ] I have provided specific details about the problem
- [ ] I have suggested concrete improvements
- [ ] I have considered the target audience
- [ ] I have checked for related issues/PRs

## 🏷 Labels
Suggested labels: documentation, needs-triage

<!-- Thank you for helping improve our documentation! -->
Loading