Skip to content

Commit 9178e69

Browse files
committed
docs: add MkDocs documentation site and align with team health philosophy
- Add MkDocs configuration with Material theme - Create docs/ directory with index, philosophy, and analysis prompt - Add GitHub Actions workflow for auto-deployment to GitHub Pages - Update README to emphasize team health over surveillance - Add real-world use case section demonstrating value - Reposition tool as 'mirror not microscope' for team reflection - Update package.json description and keywords to focus on collaboration - Clean .npmignore to exclude dev files and docs from npm package - Add CHANGELOG.md to npm package files - Move INTENT.md and analysis prompt to docs/ directory BREAKING CHANGE: git-metrics-analysis-prompt.md moved to docs/ directory
1 parent 9d18229 commit 9178e69

File tree

10 files changed

+335
-133
lines changed

10 files changed

+335
-133
lines changed

.github/workflows/docs.yml

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
name: Deploy Documentation
2+
3+
on:
4+
push:
5+
branches:
6+
- main
7+
paths:
8+
- 'docs/**'
9+
- 'mkdocs.yml'
10+
workflow_dispatch:
11+
12+
permissions:
13+
contents: write
14+
15+
jobs:
16+
deploy:
17+
runs-on: ubuntu-latest
18+
steps:
19+
- uses: actions/checkout@v4
20+
21+
- name: Setup Python
22+
uses: actions/setup-python@v5
23+
with:
24+
python-version: 3.x
25+
26+
- name: Install MkDocs
27+
run: pip install mkdocs-material
28+
29+
- name: Deploy
30+
run: mkdocs gh-deploy --force

.gitignore

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,3 +6,6 @@ build/
66
coverage/
77
test-repo/
88

9+
10+
# MkDocs
11+
site/

.npmignore

Lines changed: 22 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,29 @@
1+
# Source files
12
src/
3+
*.test.ts
4+
5+
# Build config
6+
tsconfig.json
7+
vitest.config.ts
8+
9+
# Development
210
node_modules/
11+
coverage/
12+
.vscode/
13+
.idea/
14+
15+
# Git
316
.git/
417
.gitignore
5-
tsconfig.json
18+
.github/
19+
20+
# Docs (use GitHub Pages)
21+
docs/
22+
mkdocs.yml
23+
site/
24+
25+
# Misc
626
*.log
727
.DS_Store
828
.env
29+
.npmignore

PERFORMANCE_FIXES.md

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

README.md

Lines changed: 112 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,12 @@
11
# Git Metrics MCP Server
22

3-
MCP server for analyzing git repository metrics and tracking team performance KPIs. Built for Kiro CLI (Amazon Q CLI) and other MCP clients.
3+
MCP server for analyzing git repository metrics and understanding team health. Built for Kiro CLI (Amazon Q CLI) and other MCP clients.
44

55
## Overview
66

7-
This server provides tools to extract meaningful metrics from git repositories, helping teams track productivity, code quality, and collaboration patterns.
7+
This server provides tools to extract meaningful metrics from git repositories, helping teams understand their development patterns, identify risks early, and have better conversations about code quality and team health.
8+
9+
**This is a mirror, not a microscope.** Use it to reflect on team health and process quality, not to surveil individual behavior. See [INTENT.md](INTENT.md) for our philosophy on responsible metrics usage.
810

911
## Features
1012

@@ -419,60 +421,143 @@ Analyze conventional commit usage and release patterns.
419421
}
420422
```
421423

424+
## Real-World Use Case: Team Health Analysis
425+
426+
Here's how a real engineering team used this tool to understand their development patterns across 5 repositories with 83 contributors:
427+
428+
### The Challenge
429+
A team needed to understand their development health across multiple repositories without manually parsing git logs. They wanted to identify risks, improve collaboration, and ensure sustainable work practices.
430+
431+
### What They Discovered
432+
433+
**Team Health Insights:**
434+
- ✅ Excellent work-life balance: Only 1.3% weekend commits
435+
- ✅ Strong release discipline: 114 releases with 86.3% conventional commit adoption
436+
- ⚠️ Bus factor risk: Two developers owned 61% of exclusive files in one repo
437+
- ⚠️ High fix rate (36.3%) indicated reactive development in one project
438+
439+
**Collaboration Patterns:**
440+
- Best practice: One repo had 88.9% shared files (excellent knowledge distribution)
441+
- Needs improvement: Another repo had only 30.5% shared files
442+
- Identified top collaboration pairs for knowledge sharing
443+
444+
**Code Quality Indicators:**
445+
- Found complexity hotspots: Files with 66+ changes needing refactoring
446+
- Identified technical debt: Stale files and high-churn areas
447+
- Discovered optimal commit patterns: Median 17 lines (focused commits)
448+
449+
### Actions Taken
450+
1. **Immediate:** Scheduled knowledge transfer sessions for high bus factor areas
451+
2. **Process:** Implemented pair programming to increase file sharing
452+
3. **Quality:** Added pre-commit hooks to reduce fix rate
453+
4. **Culture:** Replicated best practices from high-performing repos
454+
455+
**Time Saved:** What would have taken days of manual analysis was completed in minutes with natural language queries.
456+
457+
**Read the full analysis:** [team-activity-analysis.md](team-activity-analysis.md)
458+
459+
---
460+
422461
## Use Cases
423462

424-
### Sprint Retrospectives
463+
### ✅ Good Use Cases
464+
465+
**Sprint Retrospectives**
425466
```
426467
Show me team summary and velocity trends for the last 2 weeks
427468
What's our commit pattern? Are we burning out?
428469
```
429470

430-
### Performance Reviews
471+
**Risk Management**
431472
```
432-
Get author metrics for john@example.com since last quarter
433-
Compare their velocity to team average
473+
What's our bus factor? Who are single points of failure?
474+
Show me code ownership - where do we have knowledge concentration?
434475
```
435476

436-
### Code Quality Reviews
477+
**Code Quality Reviews**
437478
```
438479
Show me quality metrics and technical debt
439480
What files have high churn and need refactoring?
440481
```
441482

442-
### Team Health Checks
483+
**Team Health Checks**
443484
```
444-
What's our bus factor? Who are single points of failure?
485+
Are people committing late at night or on weekends?
445486
Show me collaboration metrics - is the team working together?
446487
```
447488

448-
### Onboarding Tracking
489+
**Onboarding Support**
449490
```
450491
Get commit stats for new-dev@example.com since their start date
451492
Show their velocity trend over the first 3 months
452493
```
453494

454-
## KPIs You Can Track
495+
### ❌ What This Is NOT For
496+
497+
- ❌ Micromanagement or surveillance
498+
- ❌ Comparing developers against each other
499+
- ❌ Performance review ammunition
500+
- ❌ Daily productivity tracking
501+
502+
**See [INTENT.md](INTENT.md) for our philosophy on responsible metrics usage.**
455503

456-
- **Velocity**: Commits per developer per week/sprint
457-
- **Code Volume**: Lines added/deleted
458-
- **Activity**: Files changed
504+
## Team Health Indicators You Can Track
505+
506+
### Risk Management
507+
- **Bus Factor**: Knowledge concentration risk - who are single points of failure?
508+
- **Code Ownership**: File sharing patterns - is knowledge distributed?
509+
- **Technical Debt**: Stale files, complexity hotspots needing attention
510+
511+
### Team Well-being
512+
- **Burnout Indicators**: Weekend/late-night commits - is the team overworked?
513+
- **Work Patterns**: When people commit - are boundaries healthy?
514+
- **Velocity Trends**: Sustainable pace or sprint-and-crash cycles?
515+
516+
### Code Quality
459517
- **Churn**: Files changed repeatedly (quality indicator)
460-
- **Contribution Balance**: Even distribution across team
461-
- **Commit Frequency**: Daily/weekly patterns
462-
- **Burnout Indicators**: Weekend/late-night commits
463-
- **Bus Factor**: Knowledge concentration risk
464-
- **Collaboration**: Team interaction frequency
465-
- **Quality**: Commit size, revert rate, fix rate
466-
- **Technical Debt**: Stale files, large files, complexity
518+
- **Commit Size**: Focused commits vs. large dumps
519+
- **Revert Rate**: How often do we undo work?
520+
- **Fix Rate**: Reactive (high fixes) vs. proactive development
521+
522+
### Collaboration Health
523+
- **File Sharing**: How much code is touched by multiple people?
524+
- **Collaboration Pairs**: Who works together most often?
525+
- **Contribution Balance**: Even distribution or bottlenecks?
526+
527+
### Process Maturity
528+
- **Conventional Commits**: Adoption rate of commit standards
529+
- **Release Frequency**: How often do we ship?
530+
- **Breaking Changes**: How disruptive are our releases?
531+
532+
## Tips for Responsible Usage
467533

468-
## Tips for Best Results
534+
### How to Use This Tool Well
469535

470536
1. **Use natural language**: Kiro understands context, so ask questions naturally
471-
2. **Combine metrics**: Ask for multiple analyses in one query
472-
3. **Compare periods**: Track trends over time
473-
4. **Be specific with dates**: Use "since 2025-11-01" or "last month"
474-
5. **Filter by author**: Focus on individual or team performance
475-
6. **Regular reviews**: Run weekly/monthly to track trends
537+
2. **Focus on trends, not snapshots**: Weekly/monthly patterns matter more than daily counts
538+
3. **Combine metrics**: Ask for multiple analyses to get the full picture
539+
4. **Start conversations, don't end them**: Use data to ask "why?" not to judge
540+
5. **Look for patterns**: Team health indicators, not individual performance scores
541+
6. **Regular reviews**: Weekly health checks (5 min), sprint retrospectives (15 min), monthly trends (30 min)
542+
543+
### Red Flags (Don't Do This)
544+
545+
- ❌ Checking metrics more than once per day
546+
- ❌ Creating leaderboards or rankings
547+
- ❌ Setting commit quotas or targets
548+
- ❌ Using metrics in performance reviews without context
549+
- ❌ Comparing developers directly
550+
551+
### Green Flags (Good Usage)
552+
553+
- ✅ You check trends weekly/monthly, not daily
554+
- ✅ You ask "what does this tell us about our process?"
555+
- ✅ You use it to start conversations, not end them
556+
- ✅ You focus on team health, not individual performance
557+
- ✅ You look for patterns, not outliers
558+
- ✅ You use it to help, not judge
559+
560+
**Remember:** The best teams are built on trust, not metrics. Use this tool to support your team, not surveil them.
476561

477562
## Development
478563

0 commit comments

Comments
 (0)