Skip to content

Ankh-Studio/copilot-enablement-adr

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

12 Commits
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

AI Enablement Assessment Plugin

A TypeScript library that leverages the GitHub Copilot SDK to analyze repository AI enablement readiness and generates consultant-quality Architecture Decision Records (ADRs) with evidence-based scoring, risk assessment, and phased implementation recommendations.

πŸš€ Quick Start

npm install @ankh-studio/copilot-enablement-adr
import CopilotPoweredAssessment from '@ankh-studio/copilot-enablement-adr';

const assessment = new CopilotPoweredAssessment({
  repoPath: './my-project',
  githubUrl: 'https://github.com/owner/repo',
});

const analysis = await assessment.analyze();
const adr = await assessment.generateADR(analysis);
console.log(adr);

πŸ“‹ Features

  • πŸ€– Copilot SDK Powered: Leverages GitHub Copilot's reasoning engine for analysis
  • πŸ” Focused Data Collection: Simple tools for tech stack and artifact detection
  • πŸ“Š Evidence Based Analysis: Copilot interprets signals and provides nuanced insights
  • πŸ“ Consultant Quality ADRs: Professional proposals with contextual recommendations
  • πŸ› οΈ Tool Based Architecture: Extensible with custom analysis tools

🦺 Prerequisites

This plugin requires the GitHub Copilot CLI:

# Install Copilot CLI
npm install -g @github/copilot

# Authenticate
copilot auth login

πŸ“¦ Installation

# npm
npm install @ankh-studio/copilot-enablement-adr

# yarn
yarn add @ankh-studio/copilot-enablement-adr

# pnpm
pnpm add @ankh-studio/copilot-enablement-adr

πŸ”§ Usage

Basic Usage

import { AIEnablementAssessment } from '@ankh-studio/copilot-enablement-adr';

const assessment = new AIEnablementAssessment();
const result = await assessment.analyze();
console.log(result.techStack.summary);

Advanced Usage

const assessment = new AIEnablementAssessment({
  repoPath: '/path/to/repo',
  githubUrl: 'https://github.com/owner/repo',
});

const result = await assessment.analyze();

// Access specific data
console.log('Readiness Scores:', result.readinessScores);
console.log('Recommendations:', result.recommendations);

// Generate ADR
const adr = assessment.generateADR(result);

GitHub Copilot CLI Plugin

copilot plugin install @ankh-studio/copilot-enablement-adr
copilot run ai-enablement-assessment --repo ./my-project

πŸ“Š What It Analyzes

Tech Stack Detection

  • Languages, frameworks, and dependencies
  • Infrastructure and SaaS services
  • Development tools and build systems
  • Database and storage technologies

Readiness Assessment

  • Repo Readiness (0-100): Technical foundation and hygiene
  • Team Readiness (0-100): Process and capability maturity
  • Org Enablement Readiness (0-100): Enterprise and governance readiness

8-Layer Path to Agentic Maturity

  1. Foundations - Basic repo clarity and structure
  2. Build/Test Determinism - Reproducible development workflows
  3. Documentation Spec Maturity - Adequate context for AI/human understanding
  4. Repo-Aware AI Guidance - Copilot instructions and conventions
  5. Evaluation/Verification Loops - Quality gates and review processes
  6. Tool Augmentation - MCP servers, custom agents and skills
  7. Memory/Artifact Continuity - ADRs, specs, decision logs, reusable prompts
  8. Safe Orchestration - Autonomy with guardrails, verification, measurable outcomes

πŸ“„ Output Formats

ADR Format (Primary)

# ADR: AI Enablement Assessment

## Readiness Scores

- **Repo Readiness**: 75/100 - Strong foundation
- **Team Readiness**: 60/100 - Needs process maturity
- **Org Enablement**: 45/100 - Limited governance

## Phased Implementation

### 30 Days

- Add Copilot instructions
- Implement code review process

### 60 Days

- Set up GitHub Advanced Security
- Create evaluation loops

JSON Format (Secondary)

{
  "readinessScores": {
    "repo": 75,
    "team": 60,
    "org": 45
  },
  "recommendations": [
    {
      "priority": "high",
      "category": "governance",
      "title": "Add Copilot instructions",
      "timeframe": "30 days"
    }
  ]
}

πŸ”— API Reference

See CONSUMPTION.md for detailed API documentation and integration examples.

πŸ› οΈ Development

# Clone repository
git clone https://github.com/Ankh-Studio/copilot-enablement-adr.git
cd copilot-enablement-adr

# Install dependencies
npm install

# Development workflow
npm run dev          # Watch mode
npm run build        # TypeScript compilation
npm run bundle       # Bundle for distribution
npm run format       # Prettier formatting
npm run lint         # Code quality checks

πŸ“¦ Build & Bundle

The plugin produces two distribution formats:

npm run build    # TypeScript β†’ dist/index.js (17KB)
npm run bundle   # Bundled β†’ dist/bundle.js (13.8KB)
  • dist/index.js - TypeScript compiled output with declarations
  • dist/bundle.js - Minified bundle for production use

πŸ—οΈ Architecture

This plugin follows a simple, direct implementation approach:

copilot-enablement-adr/
β”œβ”€β”€ index.ts              # Main plugin logic and analysis engine
β”œβ”€β”€ skills/               # Orchestratable skill components
β”‚   β”œβ”€β”€ tech-stack-analyzer/
β”‚   β”œβ”€β”€ security-scanner/
β”‚   β”œβ”€β”€ readiness-scorer/
β”‚   └── adr-generator/
β”œβ”€β”€ templates/            # ADR and output templates
└── dist/                 # Built distribution files

Design Philosophy

  • Small & Sharp: Focused implementation without unnecessary abstraction layers
  • Evidence-Based: Analysis grounded in concrete detected signals
  • Skill-First: Components designed for future orchestration compatibility
  • Composable: Clean upgrade path to richer agent skills without overbuilding

πŸ“‹ Dependencies

Runtime

  • @specfy/stack-analyser - Tech stack detection (700+ technologies)
  • @octokit/rest - GitHub API integration

Development

  • typescript - Type safety and compilation
  • eslint + prettier - Code quality
  • esbuild - Fast bundling

🀝 Contributing

  1. Fork the repository
  2. Create a feature branch (git checkout -b feature/amazing-feature)
  3. Commit your changes (git commit -m 'Add amazing feature')
  4. Push to the branch (git push origin feature/amazing-feature)
  5. Open a Pull Request

πŸ“„ License

MIT License - see LICENSE file for details.

πŸ†˜ Support


Built with ❀️ by Ankh Studio

About

AI Enablement Assessment Plugin for GitHub Copilot CLI

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors