Skip to content

Create comprehensive GitHub Copilot instructions with validated commands, timeouts, and integrated original content - #640

Merged
rabilrbl merged 7 commits into
developfrom
copilot/fix-639
Aug 18, 2025
Merged

Create comprehensive GitHub Copilot instructions with validated commands, timeouts, and integrated original content#640
rabilrbl merged 7 commits into
developfrom
copilot/fix-639

Conversation

Copilot AI commented Aug 18, 2025

Copy link
Copy Markdown
Contributor

This PR creates a comprehensive .github/copilot-instructions.md file 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 process: go build -o build/jiotv_go . (takes ~25 seconds, 90+ second timeout)
  • Frontend build: cd web && npm run build (takes ~2 seconds, 30+ second timeout)
  • Go tests: go test -v ./... (takes ~10 seconds, all passing, 60+ second timeout)
  • Frontend tests: cd web && npm test -- --watchAll=false --ci (takes ~5 seconds, all passing, 30+ second timeout)

Enhanced Debug Configuration: Includes both JIOTV_DEBUG=true and JIOTV_LOG_TO_STDOUT=true environment variables for complete debug functionality and auto-reloading of templates.

Accurate Tech Stack Information:

  • Go version reference updated to use go.mod specification
  • TailwindCSS v3 and DaisyUI v4 version specifications
  • Shaka Player specified for both HLS and DRM-protected DASH streaming

Integrated Original Content: Preserves essential sections from the original instructions:

  • Project overview and directory structure explanation
  • Monorepo architecture details
  • Branching strategy (main/develop/feature/bugfix/hotfix)
  • Basic development workflow guidance

Comprehensive Validation Scenarios: Specific test scenarios agents should run after making changes:

  • CLI functionality validation (./build/jiotv_go --help, etc.)
  • Server startup and HTTP response testing
  • Frontend build and test validation

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.

…ommands and timeouts

Co-authored-by: rabilrbl <63334479+rabilrbl@users.noreply.github.com>
Copilot AI changed the title [WIP] ✨ Set up Copilot instructions Create comprehensive GitHub Copilot instructions with validated commands and timeouts Aug 18, 2025
Copilot AI requested a review from rabilrbl August 18, 2025 03:54

@rabilrbl rabilrbl left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

@copilot Address these changes.

Comment thread .github/copilot-instructions.md Outdated
Comment thread .github/copilot-instructions.md Outdated
Comment thread .github/copilot-instructions.md Outdated
Comment thread .github/copilot-instructions.md Outdated
Comment thread .github/copilot-instructions.md Outdated
Comment thread .github/copilot-instructions.md
Comment thread .github/copilot-instructions.md
…ntent

Co-authored-by: rabilrbl <63334479+rabilrbl@users.noreply.github.com>

Copilot AI commented Aug 18, 2025

Copy link
Copy Markdown
Contributor Author

@copilot Address these changes.

All requested changes have been addressed in commit 7263890:

  • Added JIOTV_LOG_TO_STDOUT=true to debug environment variables (lines 81, 174)
  • Updated Go version reference to specify go.mod (line 111)
  • Updated video player description for Shaka Player (line 120)
  • Added version numbers for TailwindCSS v3 and DaisyUI v4 (line 118)
  • Integrated original project overview and directory structure content
  • Added branching strategy from original instructions

The file now combines the comprehensive validated instructions with the essential content from the original copilot instructions.

Copilot AI changed the title Create comprehensive GitHub Copilot instructions with validated commands and timeouts Create comprehensive GitHub Copilot instructions with validated commands, timeouts, and integrated original content Aug 18, 2025
Copilot AI requested a review from rabilrbl August 18, 2025 04:32
@rabilrbl
rabilrbl marked this pull request as ready for review August 18, 2025 14:50
Copilot AI review requested due to automatic review settings August 18, 2025 14:50
@rabilrbl
rabilrbl merged commit 1e93401 into develop Aug 18, 2025
3 checks passed
@rabilrbl
rabilrbl deleted the copilot/fix-639 branch August 18, 2025 14:50

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

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

Copilot AI Aug 18, 2025

Copy link

Choose a reason for hiding this comment

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

[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.'

Suggested change
**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.**

Copilot uses AI. Check for mistakes.
- [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

Copilot AI Aug 18, 2025

Copy link

Choose a reason for hiding this comment

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

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.

Suggested change
- **Video Players:** Shaka Player for HLS and DRM-protected DASH
- **Video Players:** Flowplayer for HLS streaming, Shaka Player for DRM-protected DASH

Copilot uses AI. Check for mistakes.

3. **Development with Auto-Reload (Docker):**
```bash
docker compose up

Copilot AI Aug 18, 2025

Copy link

Choose a reason for hiding this comment

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

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.

Suggested change
docker compose up
docker-compose up

Copilot uses AI. Check for mistakes.
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

3 participants