GitHub Copilot Baseline Configuration

This repository serves as the organizational baseline for GitHub Copilot instructions, prompts, and custom agents specifically adopted for AB-Lindex. It provides standardized configurations, best practices, and custom prompts to ensure consistent and effective use of GitHub Copilot across our development teams.

📥 Installation Instructions

Clone the repository and copy the configuration files directly to your project:

1. Clone to temporary directory and copy .github folder:

   💡 Note: If git is not installed on Windows, you can install it with: winget install Microsoft.Git

   Windows (PowerShell):

   # Clone to temp directory
   git clone https://github.com/AB-Lindex/github-copilot.git $env:TEMP\copilot-baseline
   
   # Copy .github folder to your project (run from your project root)
   Copy-Item -Path "$env:TEMP\copilot-baseline\.github" -Destination "." -Recurse -Force
   
   # Clean up temp directory
   Remove-Item -Path "$env:TEMP\copilot-baseline" -Recurse -Force

   macOS/Linux (Bash/Zsh):

   # Clone to temp directory
   git clone https://github.com/AB-Lindex/github-copilot.git /tmp/copilot-baseline
   
   # Copy .github folder to your project (run from your project root)
   cp -r /tmp/copilot-baseline/.github .
   
   # Clean up temp directory
   rm -rf /tmp/copilot-baseline

2. Verify installation: Check that .github/agents/, .github/instructions/, and .github/prompts/ directories now exist in your project with the baseline files.

🎯 Purpose

This repository contains:

• Custom Agents: Specialized AI assistants for specific development scenarios
• Instructions: Guidelines for code formatting and development practices
• Prompts: Meta-prompts that help discover and suggest additional GitHub Copilot resources

🙏 Acknowledgments

Most of the custom agents and prompts in this repository are adapted from github.com/github/awesome-copilot with modifications to better align with our organization's specific needs and workflows. We extend our gratitude to the GitHub Copilot community for their excellent contributions to the ecosystem.

💡 Primary Custom Agents (.github/agents)

Custom Agent	Description
README Generator	Generate comprehensive, human-friendly README.md files that adapt to project type, technology stack, and team context
PRD Assistant	Product Requirements Document generator for your project. Creates comprehensive PRDs with multi-instance deployment considerations and observability requirements
Feature Documenter	Feature design assistant for your project. Designs new features through guided questions and creates specifications that integrate with PRDs and README documentation
Implementation Planner	AI-optimized implementation planning assistant for your project. Creates structured, executable plans with repository analysis and PRD integration
Critical Thinker	Challenge assumptions and encourage critical thinking to ensure the best possible solution and outcomes

🔧 Secondary Custom Agents (.github/agents)

Custom Agent	Description
Custom Agent Development Assistant	Specialized assistant for creating, improving, and maintaining custom agent definitions for GitHub Copilot projects

💡 Instructions (.github/instructions)

Instruction	Description
Markdown Guidelines	Instructions for creating clean and professional markdown files with appropriate formatting standards

💡 Prompts (.github/prompts)

Prompt	Description
Suggest Awesome GitHub Copilot Custom Agents	Analyze repository context and suggest relevant custom agent files from the awesome-copilot repository
Suggest Awesome GitHub Copilot Prompts	Analyze repository context and suggest relevant prompt files from the awesome-copilot repository

🚀 Happy Coding !

• Review the baseline instructions in .github/instructions/
• Use the provided custom agents from .github/agents/
• Follow our organization's coding standards and best practices

📚 Best Practices

Code Generation

• Always review generated code for security vulnerabilities
• Ensure compliance with your organization's coding standards
• Test generated code thoroughly before committing
• Document any modifications made to generated code

Prompt Engineering

• Be specific about requirements and constraints
• Include context about existing codebase and patterns
• Reference relevant baseline instructions
• Iterate and refine prompts for better results

🤝 Contributing

1. Fork this repository
2. Create a feature branch
3. Add your improvements
4. Submit a Pull Request

Follow existing structure and include examples for new instructions.