Skip to content

docs: add AGENTS.md for repo workflow#113

Open
Wind-DeterMination-backup wants to merge 4 commits intoTinyLake:mainfrom
Wind-DeterMination-backup:agents-md-doc
Open

docs: add AGENTS.md for repo workflow#113
Wind-DeterMination-backup wants to merge 4 commits intoTinyLake:mainfrom
Wind-DeterMination-backup:agents-md-doc

Conversation

@Wind-DeterMination-backup
Copy link
Copy Markdown

Add a repository-level AGENTS.md summarizing the patch-first workflow, build/validation entry points, UI/i18n review preferences, and PR handling guidance.

@gemini-code-assist
Copy link
Copy Markdown

Summary of Changes

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

This pull request significantly enhances the project's documentation by adding AGENTS.md, a comprehensive guide designed to onboard new contributors and standardize development practices within the MindustryX repository. The document clarifies the repository's unique patch-first workflow, outlines essential build and validation procedures, and provides detailed best practices for coding, UI/internationalization, and the pull request review cycle. This addition aims to streamline the contribution process, improve code quality, and foster a more consistent development environment for all participants.

Highlights

  • New Contributor Guide: Introduced AGENTS.md to provide a centralized resource for understanding the MindustryX repository's development practices and expectations.
  • Workflow Standardization: Documented the project's unique patch-first workflow, detailing how to interact with Arc/ and work/ directories for development, building, and patch generation.
  • Development Best Practices: Established clear guidelines for code changes, UI/internationalization considerations, and the overall review and finalization process to ensure consistent and high-quality contributions.

🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console.

Changelog
  • AGENTS.md
    • Added a new documentation file outlining repository structure, workflow, build processes, development constraints, UI/i18n guidelines, and review procedures.
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.

Copy link
Copy Markdown

@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

此 PR 添加了 AGENTS.md 文件,为仓库贡献者提供了非常详细和清晰的工作流程、构建指南和编码规范。整体内容结构合理,对新加入的开发者非常有帮助。我发现了一些小的格式问题,主要在于代码块的语言标识和一处标点符号,已在具体的 review comments 中提出。修正这些小问题后,这份文档将更加完善。

Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
- UI 适配优先复用现有 `Table` 和项目已有布局能力,不要依赖硬编码宽高阈值或“挤不下就换行”的补丁式布局。
- 信息展示优先使用结构化组件,不要把多段信息、颜色、状态和换行需求都堆进字符串拼接。
- 不要用字符串拼接生成富文本或颜色标记文本,例如 `"[accent]" + text + "[]"`;优先拆成独立 `Label`/`Cell`,或直接对组件设置颜色、样式和布局。
- 不要滥用 `i(...)` 内联国际化 helper。正式、长期存在、可复用的 UI 文案优先写入 bundle;`i(...)` 更适合少量局部文本或确实不值得沉淀 bundle 的场景。
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

明确约束:i(...)返回值不允许进行字符串拼接。

- 临时产物路径(如手工回写 `MindustryX-temp.jar`)只能用于快速验证,不能代替 patch 再生成与正式构建链路。

## 改动约束
- 保持改动最小化、局部化,不要借修一个点顺手做风格化重构或无关清理。
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

新增:patches改动应该最小化,能在src实现不依赖patch。同一个功能的patch应该合并,而不是新建。

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

.github下面还有个copilot文件,合并到一起,可以删除旧文件。

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