多仓库多语言项目AI上下文与规则文件优化咨询
项目背景
我正在创建一个多仓库、多编程语言的项目。该项目在GitLab中名为beaufort,包含多个以风命名的子模块项目,每个子模块对应一种编程语言。
不久后,我将为每个子模块采用六边形架构(Hexagonal Architecture),并通过消息队列和REST/OpenAPI调用实现模块间协作。我希望在需要时借助AI辅助开发。
问题
我是向AI发起指令的新手。我编写的上下文和规则文件似乎可以运行,但我想知道是否存在错误,以及是否有优化空间。
父项目
在父项目beaufort的context.md中,我编写了以下内容:
# 项目上下文 ## 概述 - **名称**:beaufort - **目标**:这是一个GitLab父仓库项目,包含多个子模块。 ## 项目结构 本项目`beaufort`托管在GitLab,当前路径为本地克隆目录,其子模块包括: - **beaufort-brise**:本地克隆路径`./beaufort-brise`,编程语言为**Java** - **beaufort-ponant**:本地克隆路径`./beaufort-ponant`,编程语言为**Angular** - **beaufort-galerne**:本地克隆路径`./beaufort-galerne`,编程语言为**Rust** - **beaufort-tempete**:本地克隆路径`./beaufort-tempete`,编程语言为**C++** - **beaufort-nordet**:本地克隆路径`./beaufort-nordet`,编程语言为**Go** - **beaufort-albe**:本地克隆路径`./beaufort-albe`,编程语言为**Python** ## 技术选型与基础设施 - **托管平台**:GitLab - **CI/CD**:GitLab CI/CD - **部署方式**:Docker、Kubernetes
磁盘上的目录结构如下:
├── beaufort
│ ├── beaufort-albe (Python)
│ ├── beaufort-brise (Java)
│ ├── beaufort-galerne (Rust)
│ ├── beaufort-nordet (Go)
│ ├── beaufort-ponant (Angular)
│ └── beaufort-tempete (C++)
在父项目的rules.md中,内容如下:
# 项目开发规则 ## AI规则目标 - 定义适用于所有子模块的通用规则,AI必须遵守。 - 子模块可补充自身规则,与通用规则叠加生效。 ## 架构要求 - 遵循**六边形架构**原则。 ## 代码风格 - 各子模块的主编程语言在其`.junie/rules.md`文件中指定。 - 遵守对应编程语言的标准命名规范。 - 代码需添加注释:所有公共、受保护方法,以及类的所有成员变量都必须注释。 - `if`、`while`、`for`等条件/循环语句上方必须添加注释说明其用途。 - 源码文件及注释均使用英文编写。 ## 测试要求 - 为所有新增代码生成单元测试。 ## Git与提交规则 - AI不得执行提交操作。 - AI不得将文件添加到提交列表。 ## AI交互规则 - 交互语言可选用法语或英语。 - 开始任务前必须查阅`.junie/rules.md`和`.junie/context.md`文件。
子模块项目
每个子模块中都编写了AI相关的context.md和rules.md文件,示例如下:
示例1:Java子模块(beaufort-brise)
context.md内容:
# beaufort-brise 项目上下文 ## 概述 - **名称**:beaufort-brise - **编程语言**:Java 21 ## 技术选型与基础设施 - **API框架**:Spring Boot `4.0.5` - **日志组件**:Log4j2、Slf4j - **测试框架**:JUnit `6` - **配置管理**:Spring Boot配置属性 - **依赖管理**:Maven - **文档工具**:Javadoc - **托管平台**:GitLab - **CI/CD**:GitLab CI/CD
rules.md内容:
# beaufort-brise 开发规则 - 本项目是beaufort的子模块。 - AI必须优先查阅`../beaufort/.junie/context.md`和`../beaufort/.junie/rules.md`中的父级规则,再阅读本项目的`.junie/context.md`和`.junie/rules.md`。 ## 代码风格 - 主编程语言:Java 21
示例2:C++子模块(beaufort-tempete)
context.md内容:
# beaufort-tempete 项目上下文 ## 概述 - **名称**:beaufort-tempete - **编程语言**:C++ 23 ## 技术选型与基础设施
rules.md内容:
# beaufort-tempete 开发规则 - 本项目是beaufort的子模块。 - AI必须优先查阅`../beaufort/.junie/context.md`和`../beaufort/.junie/rules.md`中的父级规则,再阅读本项目的`.junie/context.md`和`.junie/rules.md`。 ## 代码风格 - 主编程语言:C++ 23
内容的提问来源于stack exchange,提问作者Marc Le Bihan
相关产品推荐
相关产品推荐

