Skip to content

Conversation

Copy link

Copilot AI commented Aug 17, 2025

This PR adds a comprehensive .github/copilot-instructions.md file in Traditional Chinese to significantly improve GitHub Copilot's effectiveness when working with this WordPress LMS plugin codebase.

What this solves

GitHub Copilot agents often struggle with this project due to its complex architecture:

  • Monorepo submodule structure with dependencies on Powerhouse plugin
  • Strict PHP 8.0+ requirements with mandatory declare(strict_types=1)
  • WordPress coding standards with numerous phpcs/phpstan rules
  • Frontend-backend separation using React/TypeScript + PHP
  • Traditional Chinese documentation requirements for all PHP classes/functions

Without proper guidance, agents frequently:

  • Skip the required pnpm run bootstrap setup step
  • Fail to follow strict typing requirements
  • Miss mandatory linting steps (lint:php, lint:ts)
  • Use incorrect architectural patterns
  • Waste time exploring instead of following established patterns

Key sections included

核心建置與驗證指令 (Essential Build & Validation Commands): Complete build pipeline from bootstrap through release, with timing and dependency warnings.

關鍵程式碼標準 (Critical Code Standards): Enforced requirements like declare(strict_types=1), PSR-4 namespacing (J7\PowerCourse), and Traditional Chinese comments.

專案架構 (Project Architecture): Clear directory structure, key configuration files, and monorepo dependency relationships.

常見驗證問題 (Common Validation Pitfalls): Documented solutions for frequent build failures, linting errors, and validation issues.

依賴項目與外部系統 (Dependencies & External Systems): WordPress/WooCommerce requirements, Powerhouse plugin integration, and external API usage.

The instructions are written in Traditional Chinese to align with the project's requirement for Chinese documentation, while keeping all technical commands, file paths, and code examples in their original format. This should significantly reduce failed builds, improve code quality consistency, and accelerate development velocity for any GitHub Copilot agents working on this codebase.


💬 Share your feedback on Copilot coding agent for the chance to win a $200 gift card! Click here to start the survey.

@j7-dev
Copy link
Owner

j7-dev commented Aug 17, 2025

@copilot 用繁體中文生成 .github/copilot-instructions.md 文件

Copilot AI changed the title [WIP] Your task is to "onboard" this repository to Copilot coding agent by adding a .github/copilot-instructions.md file in the repository that contains information describing how a coding agent seeing it for the first time can work most efficiently. You wi... Add comprehensive GitHub Copilot instructions for efficient code development Aug 17, 2025
Copilot AI requested a review from j7-dev August 17, 2025 12:16
Copy link
Author

Copilot AI commented Aug 17, 2025

@copilot 用繁體中文生成 .github/copilot-instructions.md 文件

已完成繁體中文版本的 .github/copilot-instructions.md 文件生成。所有技術指令、程式碼範例和檔案路徑保持原文,僅將說明性內容翻譯為繁體中文。(73b3199)

Copilot AI changed the title Add comprehensive GitHub Copilot instructions for efficient code development Add comprehensive GitHub Copilot instructions in Traditional Chinese for efficient code development Aug 17, 2025
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.

2 participants