microsoft/hve-core

Public

mirrored fromhttps://github.com/microsoft/hve-coreAvailable

CodeCommitsIssuesPull requestsActionsInsightsSecurity
feat/add-yaml-linting

Branches

Tags

  • No tags available.
0Branches0Tags
Go to file
Add file
Code

Clone

HTTPS

Download ZIP

extension/README.md

122lines · modepreview

# HVE Core Extension

> AI-powered chat agents, prompts, and instructions for hybrid virtual environments

HVE Core provides a comprehensive collection of specialized AI chat agents, prompts, and instructions designed to accelerate development workflows in VS Code with GitHub Copilot.

## Features

### 🤖 Chat Agents

Specialized AI assistants for specific development tasks:

#### Development Workflow

- **rpi-agent** - Professional evidence-backed agent with structured subagent delegation for research, codebase discovery, and complex tasks
- **task-researcher** - Research technical solutions and approaches
- **task-planner** - Plan and break down complex tasks
- **task-implementor** - Implement tasks from detailed plans
- **pr-review** - Comprehensive pull request review assistant
- **github-issue-manager** - Manage GitHub issues efficiently

#### Architecture & Documentation

- **adr-creation** - Create Architecture Decision Records
- **arch-diagram-builder** - Build high-quality ASCII-art architecture diagrams
- **brd-builder** - Build Business Requirements Documents with guided Q&A
- **prd-builder** - Build Product Requirements Documents with guided Q&A
- **prompt-builder** - Build and optimize AI prompts
- **security-plan-creator** - Expert security architect for creating comprehensive cloud security plans

#### Azure DevOps Integration

- **ado-prd-to-wit** - Convert Product Requirements Documents to Azure DevOps work items

#### Data Science & Visualization

- **gen-data-spec** - Generate data specifications and schemas
- **gen-jupyter-notebook** - Generate Jupyter notebooks for data analysis
- **gen-streamlit-dashboard** - Generate Streamlit dashboards
- **test-streamlit-dashboard** - Comprehensive testing of Streamlit dashboards

### 📝 Prompts

Reusable prompt templates for common workflows:

- **Git Operations** - Commit messages, merges, setup, and pull requests
- **GitHub Workflows** - Issue creation and management
- **Azure DevOps** - PR creation, build info, and work item management

### 📚 Instructions

Best practice guidelines for:

- **Languages** - Bash, Python, C#, Bicep
- **Git & Version Control** - Commit messages, merge operations
- **Documentation** - Markdown formatting
- **Azure DevOps** - Work item management and PR workflows
- **Task Management** - Implementation tracking and planning
- **Project Management** - UV projects and dependencies

## Getting Started

After installing this extension, the chat agents will be available in GitHub Copilot Chat. You can:

1. **Use custom agents** by selecting the custom agent from the agent picker drop-down list in Copilot Chat
2. **Apply prompts** through the Copilot Chat interface
3. **Reference instructions** - They're automatically applied based on file patterns

### Post-Installation Setup

Some chat agents create workflow artifacts in your project directory. See the [installation guide](https://github.com/microsoft/hve-core/blob/main/docs/getting-started/install.md#post-installation-update-your-gitignore) for recommended `.gitignore` configuration and other setup details.

## Usage Examples

### Using Chat Agents

```plaintext
task-planner help me break down this feature into implementable tasks
pr-review review this pull request for security issues
adr-creation create an ADR for our new microservice architecture
```

### Applying Prompts

Prompts are available in the Copilot Chat prompt picker and can be used to generate consistent, high-quality outputs for common tasks.

## Pre-release Channel

HVE Core offers two installation channels:

| Channel     | Description                                             | Maturity Levels                     |
|-------------|---------------------------------------------------------|-------------------------------------|
| Stable      | Production-ready artifacts only                         | `stable`                            |
| Pre-release | Early access to new features and experimental artifacts | `stable`, `preview`, `experimental` |

To install the pre-release version, select **Install Pre-Release Version** from the extension page in VS Code, or use the Extensions view and switch to the pre-release channel.

For more details on maturity levels and the release process, see the [contributing documentation](https://github.com/microsoft/hve-core/blob/main/docs/contributing/release-process.md#extension-channels-and-maturity).

## Requirements

- VS Code version 1.106.1 or higher
- GitHub Copilot extension

## License

MIT License - see [LICENSE](LICENSE) for details

## Support

For issues, questions, or contributions, please visit the [GitHub repository](https://github.com/microsoft/hve-core).

---

Brought to you by Microsoft ISE HVE Essentials

---

<!-- markdownlint-disable MD036 -->
*🤖 Crafted with precision by ✨Copilot following brilliant human instruction,
then carefully refined by our team of discerning human reviewers.*
<!-- markdownlint-enable MD036 -->