Skip to content

Commit 5df9a3c

Browse files
jerfowlerjerfowler
authored
feat: implement comprehensive Git Feature Branch Workflow (#2)
Merging comprehensive Git Feature Branch Workflow implementation. All documentation, templates, and branch protection configured.
1 parent d4bc69f commit 5df9a3c

File tree

7 files changed

+1378
-0
lines changed

7 files changed

+1378
-0
lines changed

‎.github/ISSUE_TEMPLATE/bug_report.md‎

Lines changed: 99 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,99 @@
1+
---
2+
name: 🐛 Bug Report
3+
about: Create a report to help us improve
4+
title: 'bug: '
5+
labels: ['bug', 'needs-triage']
6+
assignees: ''
7+
---
8+
9+
# 🐛 Bug Report
10+
11+
## 📝 Description
12+
<!-- A clear and concise description of what the bug is -->
13+
14+
## 🔄 Steps to Reproduce
15+
1. Go to '...'
16+
2. Click on '...'
17+
3. Scroll down to '...'
18+
4. See error
19+
20+
## ✅ Expected Behavior
21+
<!-- A clear and concise description of what you expected to happen -->
22+
23+
## ❌ Actual Behavior
24+
<!-- A clear and concise description of what actually happened -->
25+
26+
## 📱 Environment
27+
<!-- Please complete the following information -->
28+
- **OS**: [e.g., Ubuntu 22.04, macOS 13.0, Windows 11]
29+
- **Node.js Version**: [e.g., 18.17.0, 20.5.0, 22.0.0]
30+
- **Package Version**: [e.g., 0.6.0]
31+
- **MCP Client**: [e.g., Claude Code, custom client]
32+
- **Installation Method**: [e.g., npm install, git clone]
33+
34+
## 🖼 Screenshots/Logs
35+
<!-- If applicable, add screenshots or log output to help explain your problem -->
36+
37+
### Error Logs
38+
```
39+
Paste relevant error logs here
40+
```
41+
42+
### MCP Communication Logs
43+
```
44+
Paste MCP protocol logs if available
45+
```
46+
47+
## 🧪 Minimal Reproduction
48+
<!-- Please provide the smallest possible reproduction case -->
49+
50+
### Code Example
51+
```typescript
52+
// Minimal code that reproduces the issue
53+
```
54+
55+
### Configuration
56+
```json
57+
{
58+
"relevant": "configuration here"
59+
}
60+
```
61+
62+
## 🔍 Additional Context
63+
<!-- Add any other context about the problem here -->
64+
65+
### Frequency
66+
- [ ] Happens every time
67+
- [ ] Happens sometimes
68+
- [ ] Happened once
69+
70+
### Impact
71+
- [ ] Blocks all functionality
72+
- [ ] Blocks some functionality
73+
- [ ] Cosmetic issue
74+
- [ ] Performance issue
75+
76+
### Workaround
77+
<!-- Is there a temporary workaround? -->
78+
- [ ] No workaround found
79+
- [ ] Workaround available (please describe below)
80+
81+
### Workaround Description
82+
<!-- If you found a workaround, please describe it -->
83+
84+
## 🔧 Possible Solution
85+
<!-- If you have ideas on how to fix this bug, please describe them -->
86+
87+
## 📋 Checklist
88+
<!-- Please check all that apply -->
89+
- [ ] I have searched existing issues to make sure this is not a duplicate
90+
- [ ] I have provided all requested information
91+
- [ ] I have tested with the latest version
92+
- [ ] I have provided a minimal reproduction case
93+
- [ ] I have included relevant logs/screenshots
94+
95+
## 🏷 Labels
96+
<!-- The maintainers will add appropriate labels, but you can suggest them -->
97+
Suggested labels: bug, needs-triage
98+
99+
<!-- If this is a security issue, please email instead of creating a public issue -->

‎.github/ISSUE_TEMPLATE/documentation.md‎

Lines changed: 204 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,204 @@
1+
---
2+
name: 📚 Documentation Issue
3+
about: Report missing, incorrect, or unclear documentation
4+
title: 'docs: '
5+
labels: ['documentation', 'needs-triage']
6+
assignees: ''
7+
---
8+
9+
# 📚 Documentation Issue
10+
11+
## 📝 Issue Type
12+
<!-- Mark the appropriate option with an 'x' -->
13+
- [ ] 📝 Missing documentation
14+
- [ ] 🐛 Incorrect documentation
15+
- [ ] 🔍 Unclear/confusing documentation
16+
- [ ] 🔗 Broken links
17+
- [ ] 🌐 Translation needed
18+
- [ ] ✨ Documentation enhancement
19+
- [ ] 🧹 Outdated documentation
20+
21+
## 📍 Location
22+
<!-- Where is the documentation issue located? -->
23+
- **File**: [e.g., README.md, PROTOCOL.md, docs/api.md]
24+
- **Section**: [e.g., Installation, API Reference, Examples]
25+
- **URL**: [e.g., https://github.com/jerfowler/agent-comm-mcp-server#installation]
26+
27+
## 🔍 Current State
28+
<!-- What is currently documented (if anything)? -->
29+
<!-- Include relevant quotes from the current documentation -->
30+
31+
### Current Documentation
32+
```markdown
33+
<!-- Paste the current documentation here -->
34+
```
35+
36+
## ❌ Problem Description
37+
<!-- What is wrong, missing, or unclear? -->
38+
<!-- Be as specific as possible -->
39+
40+
### Specific Issues
41+
- [ ] Information is completely missing
42+
- [ ] Information is outdated
43+
- [ ] Examples don't work
44+
- [ ] Steps are unclear
45+
- [ ] Technical details are incorrect
46+
- [ ] Links are broken
47+
- [ ] Formatting is broken
48+
- [ ] Code snippets have errors
49+
50+
### Impact
51+
- [ ] Prevents users from getting started
52+
- [ ] Causes confusion during development
53+
- [ ] Leads to incorrect implementation
54+
- [ ] Makes troubleshooting difficult
55+
- [ ] Affects API usage
56+
57+
## ✅ Expected Documentation
58+
<!-- What should the documentation say/include? -->
59+
60+
### Proposed Content
61+
```markdown
62+
<!-- Your suggested documentation content -->
63+
```
64+
65+
### Required Information
66+
<!-- What specific information needs to be included? -->
67+
- [ ] Clear step-by-step instructions
68+
- [ ] Working code examples
69+
- [ ] Error handling examples
70+
- [ ] Configuration options
71+
- [ ] Troubleshooting section
72+
- [ ] API reference
73+
- [ ] Best practices
74+
75+
## 🎯 Target Audience
76+
<!-- Who is this documentation for? -->
77+
- [ ] New users/getting started
78+
- [ ] Developers integrating the package
79+
- [ ] Contributors to the project
80+
- [ ] MCP protocol implementers
81+
- [ ] Advanced users/power users
82+
83+
## 🌍 Context
84+
<!-- Additional context that helps understand the issue -->
85+
86+
### User Journey
87+
<!-- What is the user trying to accomplish? -->
88+
1. User wants to...
89+
2. User goes to...
90+
3. User expects to find...
91+
4. But instead finds...
92+
93+
### Related Functionality
94+
<!-- What features/APIs are related to this documentation? -->
95+
96+
### Dependencies/Prerequisites
97+
<!-- What should users know before reading this documentation? -->
98+
99+
## 💡 Suggested Solutions
100+
<!-- If you have ideas for how to fix this -->
101+
102+
### Content Improvements
103+
<!-- Specific content suggestions -->
104+
105+
### Structural Changes
106+
<!-- Changes to organization/layout -->
107+
108+
### Additional Resources
109+
<!-- Links, examples, or references that would help -->
110+
111+
## 📸 Screenshots/Examples
112+
<!-- If applicable, add screenshots showing the problem -->
113+
<!-- Or examples of good documentation from similar projects -->
114+
115+
### Current State
116+
<!-- Screenshot/example of current documentation -->
117+
118+
### Desired State
119+
<!-- Screenshot/example of how it should look -->
120+
121+
## 🔗 Related Issues
122+
<!-- Link any related issues or pull requests -->
123+
- Related to #
124+
- Fixes #
125+
- Depends on #
126+
127+
## 📋 Documentation Checklist
128+
<!-- For comprehensive documentation improvements -->
129+
130+
### Content Quality
131+
- [ ] Clear and concise language
132+
- [ ] Accurate technical information
133+
- [ ] Up-to-date examples
134+
- [ ] Proper grammar/spelling
135+
- [ ] Consistent terminology
136+
137+
### Structure
138+
- [ ] Logical organization
139+
- [ ] Proper headings/sections
140+
- [ ] Table of contents (if needed)
141+
- [ ] Cross-references
142+
- [ ] Navigation elements
143+
144+
### Examples
145+
- [ ] Working code examples
146+
- [ ] Real-world use cases
147+
- [ ] Error handling examples
148+
- [ ] Configuration examples
149+
- [ ] Integration examples
150+
151+
### Accessibility
152+
- [ ] Alt text for images
153+
- [ ] Descriptive link text
154+
- [ ] Proper markdown formatting
155+
- [ ] Screen reader friendly
156+
- [ ] Multiple format support
157+
158+
## 🤝 Contribution
159+
<!-- Are you willing to help improve this documentation? -->
160+
- [ ] I can write the missing documentation
161+
- [ ] I can review/edit existing content
162+
- [ ] I can provide examples/use cases
163+
- [ ] I can test documentation accuracy
164+
- [ ] I'm unable to contribute directly
165+
166+
## 📚 Reference Materials
167+
<!-- Links to helpful resources -->
168+
169+
### Official Documentation
170+
<!-- Links to MCP protocol docs, Node.js docs, etc. -->
171+
172+
### Similar Projects
173+
<!-- Examples from other projects with good documentation -->
174+
175+
### Style Guides
176+
<!-- Documentation style references -->
177+
178+
## 🔧 Technical Details
179+
<!-- If the issue involves code examples or API docs -->
180+
181+
### Environment
182+
- **Node.js Version**: [e.g., 18.17.0]
183+
- **Package Version**: [e.g., 0.6.0]
184+
- **Operating System**: [e.g., Ubuntu 22.04]
185+
186+
### Code Context
187+
```typescript
188+
// Relevant code that needs documentation
189+
```
190+
191+
## 📝 Additional Notes
192+
<!-- Any other information that might be helpful -->
193+
194+
## 📋 Final Checklist
195+
- [ ] I have searched existing issues for similar documentation requests
196+
- [ ] I have provided specific details about the problem
197+
- [ ] I have suggested concrete improvements
198+
- [ ] I have considered the target audience
199+
- [ ] I have checked for related issues/PRs
200+
201+
## 🏷 Labels
202+
Suggested labels: documentation, needs-triage
203+
204+
<!-- Thank you for helping improve our documentation! -->

0 commit comments

Comments
 (0)