-
-
Notifications
You must be signed in to change notification settings - Fork 27
docs: update copilot-instructions.md with latest project information #1038
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
|
Important Review skippedBot user detected. To trigger a single review, invoke the You can disable this status message by setting the Comment |
Co-authored-by: huangdijia <8337659+huangdijia@users.noreply.github.com>
There was a problem hiding this 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 updates the GitHub Copilot instructions file (.github/copilot-instructions.md) to accurately reflect the current state of the FriendsOfHyperf components monorepo. The changes align the documentation with information from AGENTS.md and CLAUDE.md, providing more comprehensive guidance for AI-assisted development.
Key Changes:
- Corrected component count from "50+" to 49, matching the actual component directories
- Added Pest as the official testing framework with group-based test organization
- Reorganized component listing into logical categories (Development Tools, Database & Models, Caching & Storage, HTTP & API, Notifications & Mail, Search, Security, Infrastructure)
- Enhanced repository structure documentation to include
types/,AGENTS.md, andCLAUDE.md - Added comprehensive testing conventions with Pest-specific examples
- Introduced coroutine safety guidelines with Context API usage patterns
- Expanded build command documentation with all composer scripts
- Added Conventional Commits format requirements
|
|
||
| - **Repository**: friendsofhyperf/components | ||
| - **Type**: Monorepo containing 50+ Hyperf components | ||
| - **Type**: Monorepo containing 49 Hyperf components |
Copilot
AI
Dec 6, 2025
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The component count has been updated to 49 in this file, but CLAUDE.md still references "50+ components" on line 7. For consistency across documentation files, consider updating CLAUDE.md to match this correction, or verify the actual component count.
Updates
.github/copilot-instructions.mdto reflect the current repository state, aligning withAGENTS.mdandCLAUDE.md.Changes
types/,AGENTS.md,CLAUDE.mdreferencescnb.yaml,update-changelog.yml)--groupexamplesHyperf\Context\ContextAPI usageaspectsandpublishkeysExample test commands added
Original prompt
💡 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.