Skip to content

Conversation

Copy link
Contributor

Copilot AI commented Sep 18, 2025

GitHub Copilot Instructions Creation - COMPLETED ✅

Successfully created comprehensive GitHub Copilot instructions for the VaeterchenFrost/AdventOfCode repository that address the multi-language and highly modular structure.

Recent Updates

  • Removed macOS compatibility reference per feedback
  • Updated file exclusions section to only mention DIRECTORY.md, removed EXCLUDED_FILENAMES reference

Repository Analysis

  • Primary Languages: PowerShell (39 files), Python (9 files), some Wolfram Mathematica
  • Structure: Year-based folders (2015-2021) with daily challenge solutions
  • Modularity: Shared utilities, scripts for automation, and package structure
  • Current Features: Auto-generating DIRECTORY.md, conda environment, pip installable package

Plan Checklist - ALL COMPLETED ✅

  • Analyze repository structure and languages used
  • Review existing code patterns and conventions
  • Understand the modular architecture
  • Create comprehensive .github/copilot-instructions.md file
  • Include PowerShell-specific guidance and patterns
  • Include Python-specific guidance and best practices
  • Address the year/day modular structure for Advent of Code solutions
  • Include guidance for shared utilities and scripts
  • Add instructions for maintaining the auto-generated DIRECTORY.md
  • Include development environment setup instructions
  • Test the instructions by reviewing sample files
  • Address feedback: remove macOS compatibility and update file exclusions

Successfully Created Instructions Include:

Repository Overview & Structure:

  • Clear description of multi-language Advent of Code repository
  • Visual folder structure diagram
  • Explanation of year-based organization

Code Generation Guidelines:

  • PowerShell patterns with exact templates matching existing code style
  • Python patterns with type annotations, logging, and proper headers
  • Wolfram Mathematica integration with license handling (validated against actual usage)

Modular Architecture Guidelines:

  • Shared utilities usage patterns (LoadAocInput.ps1, utilities/)
  • Input management with automatic download using AOC session
  • Critical warning about auto-generated DIRECTORY.md

Development Environment:

  • Complete setup instructions for conda/pip
  • PowerShell 7+ requirements
  • Optional dependencies (Wolfram, Neo4j)

Best Practices & Patterns:

  • Cross-platform compatibility considerations (Windows/Linux)
  • Performance optimizations (.NET collections, numpy)
  • Multi-language solution strategies
  • Testing and validation approaches
  • Simplified file exclusion guidelines

Validation ✅

  • Verified existing code matches documented patterns
  • Confirmed PowerShell header style and input loading patterns
  • Validated Python type annotations and logging usage
  • Checked Wolfram integration with license handling
  • Ensured all repository features are covered
  • Addressed all feedback comments

The instructions follow GitHub Copilot best practices while being specifically tailored to this repository's unique Advent of Code structure, multi-language approach, and automated tooling.

File created: .github/copilot-instructions.md (189 lines, 6.1KB)

Fixes #11.


💬 Share your feedback on Copilot coding agent for the chance to win a $200 gift card! Click here to start the survey.

Copy link
Contributor Author

Copilot AI commented Sep 18, 2025

@VaeterchenFrost 👋 This repository doesn't have Copilot instructions. With Copilot instructions, I can understand the repository better, work faster and produce higher quality PRs.

I can generate a .github/copilot-instructions.md file for you automatically. Click here to open a pre-filled issue and assign it to me. I'll write the instructions, and then tag you for review.

Copilot AI changed the title [WIP] Create Github Copilot Instructions Create comprehensive GitHub Copilot instructions for multi-language repository Sep 18, 2025

When creating new files, avoid:
- Modifying auto-generated `DIRECTORY.md`
- Creating files that match `EXCLUDED_FILENAMES` pattern (`__init__.py` in build script)
Copy link
Owner

Choose a reason for hiding this comment

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

This is not the case - creating files mentioned in build script is ok, dont cosider EXCLUDED_Filenames

## Testing and Validation

- Test solutions with provided sample inputs
- Ensure cross-platform compatibility (Windows/Linux/macOS)
Copy link
Owner

Choose a reason for hiding this comment

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

Dont really care about macOs compat

@VaeterchenFrost
Copy link
Owner

@copilot check the comments, remove macos section and update excluded filames, only mention directories.md there.

Copy link
Contributor Author

Copilot AI commented Sep 18, 2025

@copilot check the comments, remove macos section and update excluded filames, only mention directories.md there.

Updated the instructions per your feedback:

  • Removed macOS compatibility reference (line 164)
  • Updated file exclusions to only mention DIRECTORY.md, removed EXCLUDED_FILENAMES reference (lines 189-190)

Changes committed in 8117ace.

@VaeterchenFrost VaeterchenFrost marked this pull request as ready for review September 18, 2025 09:18
@VaeterchenFrost VaeterchenFrost merged commit 108b58f into main Sep 18, 2025
2 checks passed
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.

Create Github Copilot Instructions

2 participants