Skip to content

docs: init skills#5783

Draft
gxkl wants to merge 2 commits intonextfrom
docs/skills
Draft

docs: init skills#5783
gxkl wants to merge 2 commits intonextfrom
docs/skills

Conversation

@gxkl
Copy link

@gxkl gxkl commented Feb 2, 2026

No description provided.

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Feb 2, 2026

Important

Review skipped

Draft detected.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

  • 🔍 Trigger a full review
✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch docs/skills

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@gemini-code-assist
Copy link
Contributor

Summary of Changes

Hello @gxkl, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

本次拉取请求旨在初始化一个名为 @eggjs/skills 的新包,其中包含 EGG 框架的详细技能文档。这些文档旨在为开发者提供清晰的指导,帮助他们理解和应用 EGG 的核心概念,如模块化、依赖注入和对象生命周期管理,以及如何有效地使用不同类型的控制器(HTTP、MCP、Schedule)来构建应用程序。通过引入决策指南,该包将帮助用户根据其具体需求快速定位和利用相关技能。

Highlights

  • 新增 packages/skills 目录: 创建了一个新的 packages/skills 目录,用于存放 EGG 框架的技能文档。
  • 初始化 @eggjs/skills: 添加了 packages/skills/package.json 文件,定义了 @eggjs/skills 包的元数据和文件结构。
  • EGG 控制器文档: 新增 packages/skills/controller/SKILL.mdpackages/skills/controller/references/http-controller.md,详细介绍了 EGG 控制器,包括 HTTP、MCP 和 Schedule 控制器,以及 HTTPController 的全面开发指南。
  • EGG 核心概念文档: 引入了 packages/skills/tegg-core/SKILL.md,阐述了 EGG 的核心概念,如模块架构、对象生命周期(SingletonProtoContextProto)和依赖注入(@Inject)。
  • EGG 技能决策指南: 新增 packages/skills/egg/SKILL.md,作为 EGG 技能的决策指南,帮助用户在核心概念和控制器之间进行选择,并提供了决策框架和冲突解决规则。
Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature Command Description
Code Review /gemini review Performs a code review for the current pull request in its current state.
Pull Request Summary /gemini summary Provides a summary of the current pull request in its current state.
Comment @gemini-code-assist Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help /gemini help Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

  1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution.

@cloudflare-workers-and-pages
Copy link

cloudflare-workers-and-pages bot commented Feb 2, 2026

Deploying egg with  Cloudflare Pages  Cloudflare Pages

Latest commit: c40e585
Status: ✅  Deploy successful!
Preview URL: https://64d2cfc4.egg-cci.pages.dev
Branch Preview URL: https://docs-skills.egg-cci.pages.dev

View logs

@cloudflare-workers-and-pages
Copy link

cloudflare-workers-and-pages bot commented Feb 2, 2026

Deploying egg-v3 with  Cloudflare Pages  Cloudflare Pages

Latest commit: c40e585
Status: ✅  Deploy successful!
Preview URL: https://15c69ad6.egg-v3.pages.dev
Branch Preview URL: https://docs-skills.egg-v3.pages.dev

View logs

Copy link
Contributor

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

This pull request initializes the documentation for @eggjs/skills, adding several well-structured markdown files that cover core concepts, controllers, and decision guides. The documentation is a great start. I've identified a few typos in the markdown files and a potentially incorrect Node.js version requirement in package.json that should be addressed.

"dependencies": {},
"devDependencies": {},
"engines": {
"node": ">=22.18.0"
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

high

The required Node.js version >=22.18.0 seems overly restrictive and is likely a typo. Node.js 22 is very recent, and a minor version of 18 does not exist. Other documentation in the project suggests a minimum version of Node.js 18. I recommend changing this to a more common and reasonable requirement, such as >=18.0.0.

Suggested change
"node": ">=22.18.0"
"node": ">=18.0.0"


2. 定时任务,可以使用 Schedule,参考 `references/schedule.md`

3. AI集成 MCP,可以使用 MCPController,参考 `refercens/mcp-controller.md`
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

There's a typo in the file path. refercens should be references.

Suggested change
3. AI集成 MCP,可以使用 MCPController,参考 `refercens/mcp-controller.md`
3. AI集成 MCP,可以使用 MCPController,参考 `references/mcp-controller.md`

### HTTPController
- **装饰器**:`@HTTPController`、`@HTTPMethod`
- **参数**:`@HTTPParam`、`@HTTPQuery`、`@HTTPBody`、`@HTTPHeaders`、`@Cookies`、`@Request`、`@Context`
- **详细文档**:`references/httpcontroller.md`
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

There's a typo in the file path. httpcontroller.md should be http-controller.md to be consistent with other links in this file and the actual filename.

Suggested change
- **详细文档**`references/httpcontroller.md`
- **详细文档**`references/http-controller.md`

| 用户意图 | 关键词 | 使用技能 |
|---------|--------|---------|
| Module architecture | module、workspace、organization | @eggjs/skills-core |
| Object lifecycle | singleton、context、lifecycle | @eggjs/skills--core |
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

There's a typo in the skill name. @eggjs/skills--core should be @eggjs/skills-core with a single hyphen to be consistent with the rest of the document.

Suggested change
| Object lifecycle | singleton、context、lifecycle | @eggjs/skills--core |
| Object lifecycle | singleton、context、lifecycle | @eggjs/skills-core |


## 技能交互

本技能(`@eggjs/skills-tegg`)应该:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

The skill name @eggjs/skills-tegg seems inconsistent. Given the file path packages/skills/egg/SKILL.md and the frontmatter name egg, it should probably be @eggjs/skills-egg to align with other skill naming conventions like @eggjs/skills-core and @eggjs/skills-controller.

Suggested change
本技能(`@eggjs/skills-tegg`)应该:
本技能(`@eggjs/skills-egg`)应该:

@codecov
Copy link

codecov bot commented Feb 2, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 87.60%. Comparing base (8c09d7b) to head (c40e585).

Additional details and impacted files
@@            Coverage Diff             @@
##             next    #5783      +/-   ##
==========================================
+ Coverage   87.57%   87.60%   +0.02%     
==========================================
  Files         563      562       -1     
  Lines       10940    10923      -17     
  Branches     1242     1236       -6     
==========================================
- Hits         9581     9569      -12     
+ Misses       1275     1270       -5     
  Partials       84       84              

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

Copy link
Contributor

@killagu killagu left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

…es (#5786)

- Add references/mcp-controller.md with common errors, file conventions,
scenario-based decision tree, and end-to-end examples
- Update CLAUDE.md with skill writing methodology: prioritize
gap-filling over doc reformatting, interview maintainers for
undocumented knowledge
- Fix typo in controller SKILL.md (refercens -> references)

Co-authored-by: Claude Opus 4.5 <noreply@anthropic.com>
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