Skip to content

Add Copilot instructions for repository context - #11

Draft
awcodify with Copilot wants to merge 3 commits into
mainfrom
copilot/set-up-copilot-instructions
Draft

Add Copilot instructions for repository context#11
awcodify with Copilot wants to merge 3 commits into
mainfrom
copilot/set-up-copilot-instructions

Conversation

Copilot AI commented Oct 29, 2025

Copy link
Copy Markdown
Contributor

Configures GitHub Copilot coding agent with repository-specific context as per best practices.

Changes

  • .github/copilot-instructions.md - 142-line guide covering:

    • Architecture: Interface-based design with GitHubClient abstraction for testability
    • Tech stack: Go 1.21, go-github/v38, OAuth2
    • Concurrency patterns: goroutines/channels for parallel API calls
    • Testing: MockGitHubAPI for unit tests
    • Key workflows: test.yaml (CI), build_and_release.yaml, update_readme.yaml
    • Common tasks: adding statistics, modifying output format, extending API integration
  • .gitignore - Exclude build artifacts (GitInsights binary, *.out)

Enables Copilot to provide context-aware suggestions aligned with existing patterns (interface mocking, concurrent processing, README section markers).

Original prompt

This section details on the original issue you should resolve

<issue_title>✨ Set up Copilot instructions</issue_title>
<issue_description>Configure instructions for this repository as documented in Best practices for Copilot coding agent in your repository.

</issue_description>

Comments on the Issue (you are @copilot in this section)


💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.

Copilot AI and others added 2 commits October 29, 2025 04:37
Co-authored-by: awcodify <18449844+awcodify@users.noreply.github.com>
Co-authored-by: awcodify <18449844+awcodify@users.noreply.github.com>
Copilot AI changed the title [WIP] Set up Copilot instructions for the repository Add Copilot instructions for repository context Oct 29, 2025
Copilot AI requested a review from awcodify October 29, 2025 04:44
@awcodify
awcodify requested a review from Copilot October 30, 2025 06:09

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR adds initial project configuration files to support development workflow and AI-assisted coding. The changes establish ignore patterns for build artifacts and provide comprehensive Copilot instructions documenting the project's architecture and development practices.

  • Adds .gitignore to exclude build artifacts and executables
  • Adds Copilot instructions documenting project structure, technology stack, and development workflows

Reviewed Changes

Copilot reviewed 1 out of 2 changed files in this pull request and generated 1 comment.

File Description
.gitignore Excludes GitInsights binary and .out files from version control
.github/copilot-instructions.md Comprehensive documentation for AI-assisted development including project overview, architecture, testing guidelines, and common tasks

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.


### Running the Application

Requires `GITHUB_TOKEN` environment variable:

Copilot AI Oct 30, 2025

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Corrected spelling of 'Github' to 'GitHub' (capital H).

Copilot uses AI. Check for mistakes.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

✨ Set up Copilot instructions

3 participants