Skip to content

Add tested configuration management to copilot instructions#1513

Merged
donavanbecker merged 3 commits into
beta-4.1.0from
copilot/fix-1512
Sep 10, 2025
Merged

Add tested configuration management to copilot instructions#1513
donavanbecker merged 3 commits into
beta-4.1.0from
copilot/fix-1512

Conversation

Copilot AI commented Sep 10, 2025

Copy link
Copy Markdown
Contributor

This PR adds comprehensive guidance to the copilot instructions for handling issues with the "tested config" label and integrating them into the project documentation.

Overview

The repository receives user-submitted camera configurations through GitHub issues created with the "tested config" template. These configurations are valuable community contributions that should be properly processed and added to the project's documentation website at https://sunoo.github.io/homebridge-camera-ffmpeg/configs/.

Changes

Added a new "Tested Configuration Management" section to .github/copilot-instructions.md that includes:

Processing Workflow

  • How to identify issues created with the .github/ISSUE_TEMPLATE/tested_config.md template
  • Steps to extract manufacturer/model information and configuration data
  • Configuration validation requirements (JSON syntax, required fields, schema compliance)
  • Guidelines for sanitizing sensitive information (passwords, tokens, IP addresses)

Documentation Integration

  • References to the sunoo.github.io documentation website structure
  • Integration points in README.md and config.schema.json
  • Issue lifecycle management (issues with "tested config" label are exempt from stale workflow)

Best Practices

  • Categorization by camera manufacturer (Hikvision, Dahua, Reolink, etc.)
  • Configuration validation against the current plugin schema
  • Documentation maintenance and link updates

Context

The existing system already has:

  • Issue template for tested configurations that applies the "tested config" label
  • Stale workflow exemption for these issues (.github/workflows/stale.yml)
  • Documentation website references in README.md and config.schema.json

This PR ensures that copilot agents working on the repository understand how to properly handle these valuable community contributions and integrate them into the project documentation.

Fixes #1512.


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

@donavanbecker
donavanbecker changed the base branch from latest to beta-4.1.0 September 10, 2025 05:15
@donavanbecker
donavanbecker marked this pull request as ready for review September 10, 2025 05:16
donavanbecker and others added 2 commits September 10, 2025 00:16
Co-authored-by: donavanbecker <9875439+donavanbecker@users.noreply.github.com>
Copilot AI changed the title [WIP] add to tested config Add tested configuration management to copilot instructions Sep 10, 2025
Copilot AI requested a review from donavanbecker September 10, 2025 05:22
@donavanbecker
donavanbecker merged commit 244754f into beta-4.1.0 Sep 10, 2025
@donavanbecker
donavanbecker deleted the copilot/fix-1512 branch September 10, 2025 11:13
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.

add to tested config

2 participants