Create comprehensive GitHub Copilot instructions with validated commands, timeouts, and integrated original content - #640
Conversation
…ommands and timeouts Co-authored-by: rabilrbl <63334479+rabilrbl@users.noreply.github.com>
…ntent Co-authored-by: rabilrbl <63334479+rabilrbl@users.noreply.github.com>
All requested changes have been addressed in commit 7263890:
The file now combines the comprehensive validated instructions with the essential content from the original copilot instructions. |
…tions content" This reverts commit 7263890.
There was a problem hiding this comment.
Pull Request Overview
This PR creates comprehensive GitHub Copilot instructions that replace the existing basic documentation with detailed, validated development workflows and commands. The instructions provide GitHub Copilot agents with specific commands, timing expectations, and validation scenarios needed to work effectively with the JioTV Go codebase.
- Adds validated build and test commands with explicit timeout warnings and timing information
- Integrates debug configuration and comprehensive validation scenarios for CLI, server, and frontend functionality
- Preserves essential project knowledge while restructuring content for better agent usability
You can also share your feedback on Copilot code review for a chance to win a $100 gift card. Take the survey.
| This document provides instructions for GitHub Copilot to better understand the JioTV Go project and provide more relevant assistance. | ||
|
|
||
| ## 1. Project Overview | ||
| **ALWAYS follow these instructions first and fallback to search or additional context gathering ONLY when the information here is incomplete or found to be in error.** |
There was a problem hiding this comment.
[nitpick] This directive may be too restrictive for GitHub Copilot agents. Consider softening the language to allow agents to use their broader knowledge when appropriate, such as 'Prioritize these instructions but supplement with additional context when needed for completeness.'
| **ALWAYS follow these instructions first and fallback to search or additional context gathering ONLY when the information here is incomplete or found to be in error.** | |
| **Prioritize these instructions, but supplement with additional context or search when needed for completeness or when the information here is incomplete or in error.** |
| - [Shaka Player](https://shaka-player-demo.appspot.com/) for DRM-protected DASH streaming. | ||
| - **Styling:** [TailwindCSS v3](https://tailwindcss.com/) with [DaisyUI v4](https://daisyui.com/) component library | ||
| - **JavaScript:** Vanilla JavaScript (no major frameworks) | ||
| - **Video Players:** Shaka Player for HLS and DRM-protected DASH |
There was a problem hiding this comment.
This contradicts the original documentation which specified Flowplayer for HLS streaming and Shaka Player for DRM-protected DASH streaming. The change removes mention of Flowplayer entirely, which may be inaccurate if both players are actually used in the codebase.
| - **Video Players:** Shaka Player for HLS and DRM-protected DASH | |
| - **Video Players:** Flowplayer for HLS streaming, Shaka Player for DRM-protected DASH |
|
|
||
| 3. **Development with Auto-Reload (Docker):** | ||
| ```bash | ||
| docker compose up |
There was a problem hiding this comment.
The command should be docker-compose up (with hyphen) for older Docker Compose versions, or the file should specify that this requires Docker Compose v2+ for the space-separated syntax to work.
| docker compose up | |
| docker-compose up |
This PR creates a comprehensive
.github/copilot-instructions.mdfile that provides GitHub Copilot coding agents with detailed, validated instructions for working with the JioTV Go codebase, while preserving essential content from the original instructions.Key Features
Validated Commands with Explicit Timeouts: Every command has been tested and timed with "NEVER CANCEL" warnings:
go build -o build/jiotv_go .(takes ~25 seconds, 90+ second timeout)cd web && npm run build(takes ~2 seconds, 30+ second timeout)go test -v ./...(takes ~10 seconds, all passing, 60+ second timeout)cd web && npm test -- --watchAll=false --ci(takes ~5 seconds, all passing, 30+ second timeout)Enhanced Debug Configuration: Includes both
JIOTV_DEBUG=trueandJIOTV_LOG_TO_STDOUT=trueenvironment variables for complete debug functionality and auto-reloading of templates.Accurate Tech Stack Information:
Integrated Original Content: Preserves essential sections from the original instructions:
Comprehensive Validation Scenarios: Specific test scenarios agents should run after making changes:
./build/jiotv_go --help, etc.)Complete Development Lifecycle Coverage: From bootstrap to deployment, including dependency management, testing frameworks, CLI usage, GitHub workflows, and coding conventions.
The instructions provide a complete guide that enables any GitHub Copilot agent to successfully work with this codebase while maintaining all the essential project knowledge from the original instructions.
Fixes #639.
💡 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.