使用说明
测试项目
一个用于测试GitHub MCP服务器集成和Playwright文档工作流的开发项目。
📁 项目结构
test-project/
├── .github/
│ ├── chatmodes/
│ │ └── playwright.chatmode.md # Playwright-focused chat mode configuration
│ └── copilot-instructions.md # AI coding agent guidelines
├── .vscode/
│ └── settings.json # VS Code workspace settings
├── guidance/
│ ├── playwright-features.md # Comprehensive Playwright features reference
│ └── review-guidelines.md # Code review guidelines
└── README.md # This file
🎯 目的
这个项目作为以下方面的试验场:
- GitHub MCP 服务器集成 - 使用GitHub测试模型上下文协议(MCP)服务器功能
- AI聊天模式 - 为专业开发工作流定制聊天模式配置
- Playwright 文档工作流程 - 自动化文档获取与引用系统
- 开发指南 - 制定编码标准和审查流程
🚀 特性
聊天模式
- 剧作家聊天模式 - 专为与Playwright相关的查询设计的模式,该模式:
- 识别所需功能
- 从官方 Playwright 文档中获取文档
- 提供代码示例和直接链接到文档
文档系统
- Playwright 功能参考 - Playwright功能的全面列表,附带文档链接
- 评审指南 - TypeScript 和通用编码规范
开发环境设置
- VS Code 集成 - 配置了工作区设置以获得最佳开发体验
- AI编程助手指南 - GitHub Copilot及其他AI编码工具的使用说明
🛠️ 开始使用
先决条件
- Node.js(最新LTS版本)
- Git
- VS Code(推荐)
设置
-
克隆仓库:
git clone <repository-url> cd test-project -
在 VS Code 中打开:
code . -
该项目包含了预配置的VS Code设置,以提供最佳的开发体验。
📖 使用方法
使用Playwright聊天模式
该项目包含一个专为Playwright查询设计的聊天模式。激活后,它将:
- 参考文献
guidance/playwright-features.md文件以识别所需功能 - 从 playwright.dev 获取实时文档
- 提供包含代码示例的全面解答
访问文档
- Playwright 功能特性查看
guidance/playwright-features.md查看带有链接的完整功能列表 - 评审指南检查
guidance/review-guidelines.md用于编码标准
🏗️ 开发
分支结构
main/master- 稳定版feature/*- 功能开发分支- 当前活动分支:
feature/github-mcp-server-test
代码标准
- 使用 TypeScript 以确保类型安全
- 遵循格式指南
guidance/review-guidelines.md - 利用提供的指南,借助AI编程助手
.github/copilot-instructions.md
🔧 配置
VS Code 设置
该项目包括针对以下内容的VS Code设置优化:
- TypeScript 开发
- 代码格式化
- 扩展建议
AI助手配置
- GitHub Copilot 的指令已在
.github/copilot-instructions.md - 聊天模式在……中定义
.github/chatmodes/
📚 资源
Playwright 文档
- 官方Playwright文档
- 特性参考 - 本地综合特征列表
开发工具
🤝 贡献(或“参与贡献”)
- 从(某个分支)创建一个特性分支
main - 遵循以下指南
guidance/review-guidelines.md - 确保所有变更都得到妥善记录
- 提交一个包含清晰说明的拉取请求
📝 许可证
此项目仅供测试和开发之用。
🧪 测试说明
这个分支(feature/github-mcp-server-test) 正在被用于测试:
- GitHub MCP服务器集成
- 拉取请求工作流程
- 分支管理和合并流程
此README文件是作为GitHub MCP服务器测试工作流的一部分而生成的。