Skip to content

Adds Copilot instructions & agents#68

Merged
Miraeld merged 6 commits intodevelopfrom
chore/add-copilot-instructions
Dec 9, 2025
Merged

Adds Copilot instructions & agents#68
Miraeld merged 6 commits intodevelopfrom
chore/add-copilot-instructions

Conversation

@Miraeld
Copy link
Contributor

@Miraeld Miraeld commented Dec 2, 2025

Description

Fixes #xx
Nothing impacts users.
Only add copilot instructions & custom agents.

Type of change

  • Chore

Detailed scenario

What was tested

Nothing to be tested, Only md files added.

How to test

Nothing to be tested, Only md files 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:

  • Performance Beacon Agent: Introduces .github/agents/beacon-agent.md with instructions for implementing new beacon features, coding standards, architecture patterns, integration steps, and performance best practices for client-side detection beacons.
  • Build/Release Agent: Adds .github/agents/build-agent.md detailing the build pipeline, esbuild usage, CI/CD workflows, release process, troubleshooting, and boundaries for managing npm publishing and WP Rocket integration.
  • Documentation Agent: Provides .github/agents/docs-agent.md outlining 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

  • I validated all the Acceptance Criteria. If possible, provide screenshots or videos.
  • I triggered all changed lines of code at least once without new errors/warnings/notices.
  • I implemented built-in tests to cover the new/changed code.

Code style

  • I wrote a self-explanatory code about what it does.
  • I protected entry points against unexpected inputs.
  • I did not introduce unnecessary complexity.
  • Output messages (errors, notices, logs) are explicit enough for users to understand the issue and are actionnable.

Unticked items justification

Nothing needed, only md files added.

- 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
@Miraeld Miraeld requested a review from a team December 2, 2025 09:51
@Miraeld Miraeld self-assigned this Dec 2, 2025
Copilot AI review requested due to automatic review settings December 2, 2025 09:51
@codacy-production
Copy link

codacy-production bot commented Dec 2, 2025

Coverage summary from Codacy

See diff coverage on Codacy

Coverage variation Diff coverage
Report missing for 641682e1 (target: 50.00%)
Coverage variation details
Coverable lines Covered lines Coverage
Common ancestor commit (641682e) Report Missing Report Missing Report Missing
Head commit (1cedc59) 1946 1610 82.73%

Coverage variation is the difference between the coverage for the head and common ancestor commits of the pull request branch: <coverage of head commit> - <coverage of common ancestor commit>

Diff coverage details
Coverable lines Covered lines Diff coverage
Pull request (#68) 0 0 ∅ (not applicable)

Diff coverage is the percentage of lines that are covered by tests out of the coverable lines that the pull request added or modified: <covered lines added or modified>/<coverable lines added or modified> * 100%

See your quality gate settings    Change summary preferences

Footnotes

  1. Codacy didn't receive coverage data for the commit, or there was an error processing the received data. Check your integration for errors and validate that your coverage setup is correct.

Copy link
Contributor

Copilot AI left a comment

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 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>
@Miraeld Miraeld merged commit 41a6c65 into develop Dec 9, 2025
4 of 5 checks passed
@Miraeld Miraeld deleted the chore/add-copilot-instructions branch December 9, 2025 12:17
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.

3 participants