Skip to content

Conversation

Copilot
Copy link
Contributor

@Copilot Copilot AI commented Aug 16, 2025

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

What's Included

The instructions file provides:

  • Complete development workflow from initial setup to deployment
  • Exact command sequences with validated timings and timeout recommendations
  • Critical "NEVER CANCEL" warnings for long-running operations (builds take 30+ seconds, tests 60+ seconds)
  • Validation scenarios to ensure changes work correctly
  • Expected outputs and success indicators for all major commands
  • Troubleshooting guidance for common environment issues

Key Features

  • Imperative tone throughout ("Run this command", "Do not do this") for clear guidance
  • Exhaustively validated - every single command was tested and timed in the actual environment
  • Environment-aware - documents expected warnings, failures, and limitations (e.g., Electron sandbox issues in containers)
  • Technology stack reference with all major dependencies and their purposes

Sample Instructions

# Bootstrap the repository
pnpm install  # takes 2.5 minutes. NEVER CANCEL. Set timeout to 5+ minutes.

# Build the application  
pnpm build    # takes 32 seconds. NEVER CANCEL. Set timeout to 60+ minutes.

# Run tests
pnpm test     # takes 67 seconds. NEVER CANCEL. Set timeout to 30+ minutes.

The instructions start with the required directive: "ALWAYS follow these instructions first and only fallback to additional search and context gathering if the information in the instructions is incomplete or found to be in error."

This will significantly improve GitHub Copilot's effectiveness when working on Gitify by providing it with the exact context it needs about build processes, timing expectations, validation steps, and common pitfalls.

Fixes #2154.


💡 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.

Co-authored-by: setchy <386277+setchy@users.noreply.github.com>
@Copilot Copilot AI changed the title [WIP] ✨ Set up Copilot instructions Add comprehensive GitHub Copilot development instructions for Gitify Aug 16, 2025
@Copilot Copilot AI requested a review from setchy August 16, 2025 11:38
Copilot finished work on behalf of setchy August 16, 2025 11:38
@setchy setchy changed the title Add comprehensive GitHub Copilot development instructions for Gitify docs: Add comprehensive GitHub Copilot development instructions for Gitify Aug 16, 2025
@github-actions github-actions bot added the documentation Improvements or additions to documentation label Aug 16, 2025
Copy link

@setchy setchy marked this pull request as ready for review August 16, 2025 11:55
@setchy setchy merged commit 8ca9973 into main Aug 16, 2025
27 of 31 checks passed
@setchy setchy deleted the copilot/fix-2154 branch August 16, 2025 11:55
@github-actions github-actions bot added this to the Release 6.6.0 milestone Aug 16, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

✨ Set up Copilot instructions
2 participants