Skip to content

Conversation

Copy link
Contributor

Copilot AI commented Oct 29, 2025

Configure repository-specific instructions for GitHub Copilot coding agents per best practices documented at gh.io/copilot-coding-agent-tips.

Changes

Expanded existing AGENTS.md from basic conventions to comprehensive agent guidance:

  • Project Context: Repository overview, technology stack (Python 3.9+, Flask, pytest, Ruff), and educational focus
  • Project Structure: Complete directory layout with module organization (algorithms/, graphs/, dp/, etc.)
  • Development Commands: Setup, test execution, linting/formatting, demo running, and documentation building
  • Code Standards: Algorithm implementation template with complexity notation, naming conventions, and docstring requirements
  • Architecture: Demo discovery system, pattern categorization, and deterministic testing requirements
  • Testing: Framework configuration in pyproject.toml, coverage defaults, and test writing guidelines
  • Security & Dependencies: No hardcoded secrets, minimal dependencies, local-only Flask app
  • Workflows: Pre-commit hooks, CI pipeline steps, and PR acceptance criteria
  • Agent-Specific Guidance: Common pitfalls, quick reference commands, and development cycle summary

Example Structure

Agents now receive clear implementation guidance:

def algorithm_name(input_data, param=default):
    """
    Brief description of what the algorithm does.
    
    Time complexity: O(n log n)
    Space complexity: O(n)
    
    Args:
        input_data: Description
        param: Description (default: value)
    
    Returns:
        Description of return value
    
    Common pitfalls:
    - Edge case 1
    - Edge case 2
    """
    pass

def demo():
    """Demonstrate the algorithm with examples."""
    pass

Includes clarifications that test configuration lives in pyproject.toml (not pytest.ini) and that pytest -q runs with coverage by default.

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 02:49
Co-authored-by: ianlintner <500914+ianlintner@users.noreply.github.com>
Co-authored-by: ianlintner <500914+ianlintner@users.noreply.github.com>
@ianlintner ianlintner marked this pull request as ready for review October 29, 2025 02:52
Copilot AI review requested due to automatic review settings October 29, 2025 02:52
Copilot AI changed the title [WIP] Set up Copilot instructions for repository Enhance AGENTS.md with comprehensive Copilot coding agent instructions Oct 29, 2025
Copilot AI requested a review from ianlintner October 29, 2025 02:53
Copy link

Copilot AI left a comment

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 applies consistent code formatting across multiple Python files, primarily converting multi-line list comprehensions and function signatures to single-line format where appropriate. The changes improve code conciseness while maintaining readability, aligning with Python style conventions for shorter constructs.

Key Changes:

  • Consolidated multi-line list comprehensions and function signatures to single lines
  • Added blank lines for better spacing in docs_server.py
  • Significantly expanded the AGENTS.md documentation with comprehensive guidelines for AI coding agents

Reviewed Changes

Copilot reviewed 10 out of 10 changed files in this pull request and generated no comments.

Show a summary per file
File Description
flask_app/visualizations/topo_viz.py Consolidated list comprehension from 2 lines to 1 line
flask_app/visualizations/sorting_viz.py Consolidated function signatures from 3 lines to 1 line
flask_app/visualizations/path_viz.py Consolidated multiple list initializations and function signatures to single lines
flask_app/visualizations/nn_viz.py Consolidated list comprehension and loss calculation to single lines
flask_app/visualizations/mst_viz.py Consolidated function signatures to single lines
flask_app/visualizations/graph_viz.py Consolidated function signatures to single lines
flask_app/visualizations/array_viz.py Consolidated list initializations and function calls to single lines
flask_app/docs_server.py Added blank lines for improved spacing between imports and function definitions
flask_app/app.py Consolidated list comprehensions and error handling to maintain line length limits
AGENTS.md Expanded from basic guidelines to comprehensive 450+ line documentation for AI agents

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

ianlintner added a commit that referenced this pull request Oct 29, 2025
… in PR #3 (#4)

* Initial plan

* Fix trailing whitespace in AGENTS.md docstring example

Co-authored-by: ianlintner <500914+ianlintner@users.noreply.github.com>

---------

Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com>
Co-authored-by: ianlintner <500914+ianlintner@users.noreply.github.com>
@ianlintner ianlintner closed this Oct 29, 2025
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

2 participants