+
Skip to content

Organizational baseline configuration for GitHub Copilot with standardized chat modes, instructions, and prompts for AB-Lindex development teams. Includes specialized AI assistants, coding guidelines, and reusable templates to enhance developer productivity and ensure consistent AI-assisted development practices.

Notifications You must be signed in to change notification settings

AB-Lindex/github-copilot

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

4 Commits
 
 
 
 
 
 
 
 

Repository files navigation

GitHub Copilot Baseline Configuration

This repository serves as the organizational baseline for GitHub Copilot instructions, prompts, and chat modes 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

Choose one of the following methods to install the GitHub Copilot Baseline configuration:

Method 1: Direct Installation (Recommended)

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/chatmodes/, .github/instructions/, and .github/prompts/ directories now exist in your project with the baseline files.

Method 2: Using Install Prompt

To use the Install Copilot Baseline prompt in your VS Code environment:

  1. Create the prompts directory (if it doesn't exist):

    • Windows + VS Code: %AppData%\Code\User\prompts\
      Open a terminal or the Run dialog and run the following command:
      cmd /c "mkdir %AppData%\Code\User\prompts"
    • Windows + Visual Studio: chatmodes not supported yet
  2. Download the prompt file:

    • Navigate to install-copilot-baseline.prompt.md (right-click and "Open in new tab" recommended)
    • Click the Download button ( ) in the top right of the file view
    • Save the file to your desired prompts directory (see step 1)
  3. Use the prompt: Type /install-copilot-baseline in GitHub Copilot Chat to use the install-prompt.

    💡 Tip: You can re-run /install-copilot-baseline anytime to get the latest updates from this repository and ensure you have the most current chat modes, instructions, and prompts.

🎯 Purpose

This repository contains:

  • Chat Modes: 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 chat modes 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 Chat Modes (.github/chatmodes)

Chat Mode 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 Chat Modes (.github/chatmodes)

Chat Mode Description
Chatmode Assistant Specialized assistant for creating, improving, and maintaining chatmode 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 Chatmodes Analyze repository context and suggest relevant chatmode 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 chat modes from .github/chatmodes/
  • 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.

About

Organizational baseline configuration for GitHub Copilot with standardized chat modes, instructions, and prompts for AB-Lindex development teams. Includes specialized AI assistants, coding guidelines, and reusable templates to enhance developer productivity and ensure consistent AI-assisted development practices.

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published
点击 这是indexloc提供的php浏览器服务,不要输入任何密码和下载