Skip to content

Add comprehensive GitHub Copilot instructions for sshdol development - #5

Merged
thorwhalen merged 2 commits into
masterfrom
copilot/fix-4
Aug 20, 2025
Merged

thorwhalen merged 2 commits into
masterfrom
copilot/fix-4

Conversation

Copilot AI commented Aug 20, 2025 •

Copy link
Copy Markdown
Contributor

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

The instructions file includes:

Essential Development Commands:

  • Complete installation and setup procedures with validated timeouts
  • Build validation, testing, linting, and formatting commands
  • Documentation build process using Sphinx
  • All commands have been tested and include proper "NEVER CANCEL" warnings with measured execution times

Repository Navigation:

  • Detailed project structure with key files and directories
  • Core classes and methods reference (SshFiles, SshTextFiles)
  • Critical dependencies and their purposes (paramiko, py2store, rsync)

Development Workflow:

  • SSH testing requirements and limitations (tests need remote server access)
  • Manual validation scenarios that work without SSH connections
  • Copy-paste friendly validation commands for quick development checks
  • Proper timeout values based on actual measurements (30s for install, 15s for docs, etc.)

Key Features:

  • Starts with firm directive to follow instructions first before searching
  • Provides exhaustive validation that covers import checks, method availability, and dependency verification
  • Documents CI pipeline requirements and formatting/linting expectations
  • Includes practical examples for common development tasks

All commands in the instructions have been validated to work correctly, with proper error handling for scenarios where SSH access is not available (common in development environments).

Fixes #4.


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

Co-authored-by: thorwhalen <1906276+thorwhalen@users.noreply.github.com>
Copilot AI changed the title [WIP] ✨ Set up Copilot instructions Add comprehensive GitHub Copilot instructions for sshdol development Aug 20, 2025
Copilot AI requested a review from thorwhalen August 20, 2025 10:21
@thorwhalen

Copy link
Copy Markdown
Member

@copilot, I'm not sure what I'm supposed to do here!

Copilot AI commented Aug 20, 2025

Copy link
Copy Markdown
Contributor Author

@copilot, I'm not sure what I'm supposed to do here!

I've completed the work requested in issue #4. I created a comprehensive .github/copilot-instructions.md file that provides GitHub Copilot coding agents with detailed instructions for working in the sshdol codebase.

The file includes:

  • Complete development setup and validation commands
  • Repository structure and key classes reference
  • Build times, testing requirements, and SSH configuration notes
  • Copy-paste friendly validation scenarios that work without SSH access
  • CI pipeline documentation

No action is needed from you unless you'd like to review or modify the instructions. The PR is ready to merge and will help future Copilot agents work more effectively in this repository.

Commit: c96a32c

@thorwhalen thorwhalen left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Okay. Thank you

@thorwhalen
thorwhalen marked this pull request as ready for review August 20, 2025 17:10
@thorwhalen
thorwhalen merged commit e547e1c into master Aug 20, 2025
1 of 3 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.

✨ Set up Copilot instructions

2 participants