Skip to content

Add AI guidelines to API documentation - #3

Merged
Tosd0 merged 2 commits into
mainfrom
claude/add-ai-guidelines-011CUptBDDJyrkGfSBbsVcgZ
Nov 5, 2025
Merged

Add AI guidelines to API documentation#3
Tosd0 merged 2 commits into
mainfrom
claude/add-ai-guidelines-011CUptBDDJyrkGfSBbsVcgZ

Conversation

@Tosd0

@Tosd0 Tosd0 commented Nov 5, 2025

Copy link
Copy Markdown
Owner

为README和两个标准文档添加AI使用须知:

  • API标准必须严格遵循
  • Service Worker规范为推荐实现
  • 扩展功能应使用可选字段或metadata
  • 发现问题应联系仓库负责人,不应直接修改标准文档

为README和两个标准文档添加AI使用须知:
- API标准必须严格遵循
- Service Worker规范为推荐实现
- 扩展功能应使用可选字段或metadata
- 发现问题应联系仓库负责人,不应直接修改标准文档
@gemini-code-assist

Copy link
Copy Markdown
Contributor

Summary of Changes

Hello @Tosd0, 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!

本次拉取请求旨在通过在核心文档中引入AI编程助手使用指南,规范用户(尤其是AI辅助用户)与技术标准文档的交互方式。这些指南旨在确保标准的完整性和一致性,同时为功能扩展和问题反馈提供清晰的路径,从而维护文档的权威性和可维护性。

Highlights

  • AI使用须知添加: 在README.mdstandards/active-messaging-api.mdstandards/service-worker-specification.md文件中新增了关于AI编程助手使用的指导原则。
  • API标准严格遵循: 明确指出API标准(如端点、格式、字段)必须严格遵循,不应随意修改。
  • Service Worker规范为推荐实现: 指出Service Worker规范为推荐实现方案,允许根据实际需求灵活调整,但通知数据结构需与API标准保持一致。
  • 扩展功能方式: 强调扩展功能应通过可选字段或元数据实现,而非修改现有标准字段。
  • 问题处理流程: 规定发现标准问题时应联系仓库负责人讨论,不应直接修改标准文档。
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.

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

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Code Review

本次 PR 为三个核心文档(README、API 标准、Service Worker 规范)添加了 AI 编程助手使用须知,这是一个非常有价值的补充,能够有效引导 AI 工具正确理解和使用仓库中的技术标准,避免误操作。整体内容清晰,要点明确。我针对文档中的一些措辞提出了几点微调建议,主要是为了增强指引的精确性和一致性,例如将模糊的“用户”一词统一为更具体的“开发者”,并统一了 metadata 的表述方式。这些修改将使文档对开发者和 AI 都更加友好。

Comment thread README.md Outdated
Comment thread standards/active-messaging-api.md Outdated
Comment thread standards/active-messaging-api.md Outdated
Comment thread standards/service-worker-specification.md Outdated
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.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