Conversation
- Add coding standards and architecture patterns - Document test patterns with Mocha/Sinon - Include build configuration and commands - Define error handling conventions - Document integration with WP Rocket - Provide debugging tips and best practices
- Specialized agent for writing Mocha/Sinon tests - Includes browser API mocking patterns - Provides test structure templates (arrange/act/assert) - Documents common test scenarios for beacons - Defines boundaries for test writing vs implementation
- Specialized agent for implementing beacon features - Includes performance-critical coding patterns - Documents browser API usage for beacons - Provides beacon class template and structure - Defines integration checklist with BeaconManager
- Specialized agent for esbuild configuration - Documents build pipeline and verification - Includes GitHub Actions workflow details - Provides release process and version management - Defines CI/CD monitoring and troubleshooting
- Specialized agent for technical writing - Includes JSDoc comment templates - Documents README.md structure requirements - Provides documentation review checklist - Defines markdown formatting standards
Coverage summary from CodacySee diff coverage on Codacy
Coverage variation details
Coverage variation is the difference between the coverage for the head and common ancestor commits of the pull request branch: Diff coverage details
Diff coverage is the percentage of lines that are covered by tests out of the coverable lines that the pull request added or modified: See your quality gate settings Change summary preferencesFootnotes
|
There was a problem hiding this comment.
Pull request overview
This PR adds comprehensive GitHub Copilot instructions and specialized agent documentation to streamline development workflows for the rocket-scripts project. The documentation establishes clear coding standards, testing patterns, build processes, and role-specific guidelines.
Key Changes:
- Added main Copilot instructions with architecture patterns, coding standards, and browser API usage guidelines
- Created four specialized agent guides for test engineering, documentation, build/release management, and beacon implementation
- Established consistent patterns for development workflows including testing, building, and integration with WP Rocket
Reviewed changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
.github/copilot-instructions.md |
Comprehensive guide covering project architecture, ES6 module patterns, DOM/browser APIs, testing standards, build process, and performance considerations for the beacon functionality |
.github/agents/test-agent.md |
Quality engineer agent documentation for writing Mocha/Sinon tests, mocking browser APIs, and ensuring comprehensive test coverage |
.github/agents/docs-agent.md |
Technical writer agent guide for maintaining README, JSDoc comments, and code documentation with clear writing standards and examples |
.github/agents/build-agent.md |
Build/release engineer documentation covering esbuild configuration, CI/CD workflows, npm publishing, and WP Rocket integration process |
.github/agents/beacon-agent.md |
Performance optimization specialist guide for implementing new beacon features with coding standards, browser API patterns, and integration steps |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Description
Fixes #xx
Nothing impacts users.
Only add copilot instructions & custom agents.
Type of change
Detailed scenario
What was tested
Nothing to be tested, Only
mdfiles added.How to test
Nothing to be tested, Only
mdfiles added.Technical description
Documentation
This pull request adds detailed agent documentation for the rocket-scripts project, covering three specialized roles: performance beacon implementation, build/release management, and technical documentation. Each agent file provides clear responsibilities, technical context, coding standards, and boundaries for contributors. These guides are designed to streamline onboarding, clarify team roles, and ensure best practices across development, build, and documentation workflows.
Agent responsibilities and workflow documentation:
.github/agents/beacon-agent.mdwith instructions for implementing new beacon features, coding standards, architecture patterns, integration steps, and performance best practices for client-side detection beacons..github/agents/build-agent.mddetailing the build pipeline, esbuild usage, CI/CD workflows, release process, troubleshooting, and boundaries for managing npm publishing and WP Rocket integration..github/agents/docs-agent.mdoutlining documentation standards, JSDoc comment patterns, README structure, writing style guidelines, review checklists, and update frequency for maintaining technical documentation and code comments.Mandatory Checklist
Code validation
Code style
Unticked items justification
Nothing needed, only md files added.