zwave-js / zwave-js-ui / 17575577570

20%

push

github

chore: add comprehensive GitHub Copilot instructions for development workflow (#4358)

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

## Key Features

**Imperative Instructions with Validated Commands**
- All commands have been tested and validated to work correctly
- Includes exact timing measurements for build processes and tests
- Explicit "NEVER CANCEL" warnings with timeout recommendations for
long-running operations

**Conventional Commit Standards**
- Comprehensive section on conventional commit format requirements
- Examples for commit messages and PR titles/descriptions
- Enforcement of consistent project standards for all contributions

**Complete Development Workflow Coverage**
- Prerequisites and installation (Node.js 20.19+, npm dependencies)
- Build process: Frontend (17s), Backend (2s), PWA (1s) 
- Testing: 3s total runtime with 103 passing tests
- Development servers: Mock Z-Wave controller, backend (:8091), frontend
(:8092)
- Optimized code quality workflow: lint-fix first, then lint for
efficiency

**Enhanced Manual Validation Scenarios**
- Complete settings.json configuration based on CI test workflow
- Step-by-step Z-Wave integration testing with proper mock controller
setup
- Production-ready test application configuration matching
`.github/workflows/test-application.yml`
- Complete application functionality verification with MQTT and gateway
settings

**Repository Structure Documentation**
- Key directories: `api/` (TypeScript backend), `src/` (Vue frontend),
`server/` (compiled output)
- Important configuration files and their purposes
- Environment variables and deployment options

**Production Deployment Guidance**
- Bundle creation (3s, 11.4MB optimized package)
- Docker containerization
- Binary packaging with `@yao-pkg/pkg`

## Validation Process

Every command and instruction was ... (continued)

346 of 452 branches covered (76.55%)

Branch coverage included in aggregate %.

3963 of 20560 relevant lines covered (19.28%)

1.23 hits per line