copilot-instructions.md

把这些写进 .github/copilot-instructions.md，Copilot Chat 就会在你与它对话时自动带入这些约定，帮你生成更符合项目风格的代码

1. # Next.js 项目指令
   
2. 
   
3. ## 项目结构
   
4. - 使用 `app/` （或 `pages/`）目录路由：同一路由只保留一个目录  
   
5. - 公共组件放在 `components/`，按照「原子组件（atoms）→组合组件（molecules）→页面组件（organisms）」分层  
   
6. - 静态资源放在 `public/`，避免在代码里直接引用外部 URL
   
7. 
   
8. ## 技术栈
   
9. - **语言**：TypeScript，开启 `"strict": true` 和 `"forceConsistentCasingInFileNames": true`  
   
10. - **样式**：Tailwind CSS，遵循 BEM 思想命名，所有样式写在 `className` 里  
    
11. - **UI 库**：优先使用 shadcn/ui 组件；自定义组件要有可控的 `size`、`variant`、`className` 等接口  
    
12. - **数据获取**：使用 React-Query（@tanstack/react-query）或 SWR，封装统一的 `useFetch`／`useMutation` 钩子
    
13. 
    
14. ## 代码质量
    
15. - **格式化**：Prettier（单行最大 88 列）  
    
16. - **静态检查**：ESLint+TypeScript，规则继承 `eslint:recommended`、`plugin:@typescript-eslint/recommended`  
    
17. - **导入排序**：用 `eslint-plugin-import` 按类别（内置模块→第三方→别名路径→相对路径）自动排序  
    
18. - **Git 提交**：遵循 Conventional Commits，类型只用 feat/fix/docs/style/refactor/test/chore
    
19. 
    
20. ## 文档 & 注释
    
21. - 所有公开导出的组件／函数必须有 JSDoc（Google 风格）  
    
22. - 路由文件顶部注释写明页面功能、SEO 关键字、是否需要认证
    
23. 
    
24. ## 环境 & 部署
    
25. - **环境变量**：使用 `.env.local`、`.env.production`，代码里通过 `process.env.NEXT_PUBLIC_…` 访问  
    
26. - **CI/CD**：GitHub Actions 自动跑 `lint`、`type-check`、`build`；主分支合并触发部署到 Vercel  
    
27. - **性能优化**：开启 `next/image`、`next/font`；对第三方库做动态 import；SSR 路由加 `revalidate` 缓存策略
    
28. 
    
29. ## 测试
    
30. - **单元测试**：Jest + Testing Library；所有组件至少有一个交互／快照测试  
    
31. - **集成测试**：Playwright 或 Cypress，覆盖主要用户流程（登录、表单、导航）
    
32. 
    
33. ## 安全 & 规范
    
34. - 严禁在前端暴露敏感密钥  
    
35. - 使用 `next-secure-headers` 或自定义 `headers()` 加强安全头  

复制代码

好奇现在copilot使用感觉如何 和cursor比呢

Next.js 项目指令——其他项目是不是有些东西要改改

test0_ 发表于 2025-5-21 20:45
Next.js 项目指令——其他项目是不是有些东西要改改

根据自己的需求去改

SQLException 发表于 2025-5-21 20:38
好奇现在copilot使用感觉如何 和cursor比呢

cursor 对整体代码库的把握比较好