Skip to content

Add comprehensive GitHub Copilot instructions for repository development workflow#166

Merged
youngtaekiim merged 4 commits into
mainfrom
copilot/fix-165
Aug 18, 2025
Merged

Add comprehensive GitHub Copilot instructions for repository development workflow#166
youngtaekiim merged 4 commits into
mainfrom
copilot/fix-165

Conversation

Copy link
Copy Markdown
Contributor

Copilot AI commented Aug 9, 2025

This PR adds a comprehensive .github/copilot-instructions.md file that provides GitHub Copilot with detailed instructions for working effectively in the Pullpiri codebase.

Key Features

The instructions file includes:

  • Firm directive to always reference these instructions first before falling back to search or bash commands
  • Imperative tone commands with exact execution times and timeout requirements
  • "NEVER CANCEL" warnings for long-running operations with specific time estimates
  • Complete validation workflow for pre-commit checks
  • Project structure navigation guide for the Rust microservices architecture

Validated Commands and Timings

All commands have been thoroughly tested and validated:

  • Dependencies installation: scripts/installdeps.sh (8m20s - requires 15+ min timeout)
  • Build process: make build (5-7 minutes - requires 15+ min timeout)
  • Format checking: scripts/fmt_check.sh (1.3 seconds)
  • Lint checking: scripts/clippy_check.sh (2m34s - requires 10+ min timeout)
  • Unit testing: cargo test --manifest-path=src/{component}/Cargo.toml (4.1s for common)
  • Complete workflow: Format→Lint→Build→Test takes ~7m40s total

Developer Workflow Guidance

The instructions provide:

  • Bootstrap sequence for new developers with exact dependency requirements
  • Daily development workflow with validation steps that must be run before commits
  • Troubleshooting section documenting known limitations (container build permissions, external test dependencies)
  • Quick reference commands for immediate productivity

Project-Specific Details

Includes comprehensive information about:

  • Port usage: Services use 47001-47099, etcd uses 2379-2380
  • Architecture: Rust microservices (server, agent, player, tools, common)
  • Build system: Cargo with workspace structure managed by Makefile
  • Required tools: Rust toolchain, etcd, protobuf-compiler, Docker/Podman

Validation Scenarios

The instructions guide developers to:

  • Always run formatting and linting checks before committing
  • Build and test affected components after making changes
  • Use specific timeout values to prevent premature cancellation of builds
  • Follow the complete validation sequence for CI pipeline success

This ensures that GitHub Copilot can provide accurate, actionable guidance to developers working in the Pullpiri repository, reducing onboarding time and preventing common development workflow mistakes.

Fixes #165.

Warning

Firewall rules blocked me from connecting to one or more addresses

I tried to connect to the following addresses, but was blocked by firewall rules:

  • esm.ubuntu.com
    • Triggering command: /usr/lib/apt/methods/https (dns block)

If you need me to access, download, or install something from one of these locations, you can either:


✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.

@Chulhee1Lee
Copy link
Copy Markdown
Contributor

현재 Copilot Coding Agent를 활용해서 테스트를 진행해보고 있습니다.

@Chulhee1Lee Chulhee1Lee marked this pull request as ready for review August 9, 2025 15:34
Copilot AI changed the title [WIP] ✨Set up Copilot instructions Add comprehensive GitHub Copilot instructions for repository development workflow Aug 9, 2025
Copilot AI requested a review from Chulhee1Lee August 9, 2025 16:01
@Chulhee1Lee Chulhee1Lee requested a review from Copilot August 10, 2025 13:38
Copy link
Copy Markdown
Contributor

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 introduces comprehensive GitHub Copilot instructions for the Pullpiri repository, providing detailed guidance for development workflow, build processes, and project navigation. The instructions are designed to help GitHub Copilot provide more accurate and actionable assistance to developers working in this Rust-based vehicle service orchestrator codebase.

  • Adds detailed build and validation workflows with specific timing requirements and timeout warnings
  • Provides complete project structure documentation and component navigation guidance
  • Establishes pre-commit validation sequences to ensure CI pipeline success

Comment thread .github/copilot-instructions.md Outdated
Comment thread .github/copilot-instructions.md
Comment thread .github/copilot-instructions.md
youngtaekiim and others added 2 commits August 18, 2025 15:19
Co-authored-by: Chulhee1Lee <104404644+Chulhee1Lee@users.noreply.github.com>
… and timings

Co-authored-by: Chulhee1Lee <104404644+Chulhee1Lee@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
@youngtaekiim youngtaekiim merged commit 0057c02 into main Aug 18, 2025
6 checks passed
chaehee-lim pushed a commit to chaehee-lim/pullpiri that referenced this pull request Sep 3, 2025
…/fix-165

Add comprehensive GitHub Copilot instructions for repository development workflow
@youngtaekiim youngtaekiim deleted the copilot/fix-165 branch September 4, 2025 08:02
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

4 participants