51 lines
1.2 KiB
Markdown
51 lines
1.2 KiB
Markdown
# 项目档案
|
|
|
|
复制模板后先填写本页。这里保存不经常变化、所有维护者都需要知道的信息。
|
|
|
|
## 基本信息
|
|
|
|
| 项目 | 内容 |
|
|
|---|---|
|
|
| 项目名称 | `<填写>` |
|
|
| 一句话目标 | `<填写>` |
|
|
| Gitea 地址 | `<例如 https://gitea.example.com>` |
|
|
| 仓库 | `<owner/repository>` |
|
|
| 默认分支 | `main` |
|
|
| 主要维护者 | `<填写>` |
|
|
|
|
## 技术栈
|
|
|
|
| 部分 | 技术 | 规则文件 |
|
|
|---|---|---|
|
|
| `<子项目或服务>` | `<语言、框架、版本>` | `<路径/AGENTS.md>` |
|
|
|
|
## 常用命令
|
|
|
|
所有命令默认从仓库根目录执行。
|
|
|
|
| 用途 | 命令 | 预期结果 |
|
|
|---|---|---|
|
|
| 安装依赖 | `<填写>` | `<填写>` |
|
|
| 启动开发环境 | `<填写>` | `<填写>` |
|
|
| 格式检查 | `<填写>` | `<填写>` |
|
|
| 静态检查 | `<填写>` | `<填写>` |
|
|
| 单元测试 | `<填写>` | `<填写>` |
|
|
| 集成测试 | `<填写或写“不适用”>` | `<填写>` |
|
|
|
|
## 目录边界
|
|
|
|
| 目录 | 职责 | 不应放入 |
|
|
|---|---|---|
|
|
| `<路径>` | `<填写>` | `<填写>` |
|
|
|
|
## 环境与凭据
|
|
|
|
- 本地配置文件：`<填写>`
|
|
- 配置示例文件：`<填写>`
|
|
- 凭据保存位置：`<只写保存方式，不填写真实凭据>`
|
|
- 日志和构建产物位置：`<填写>`
|
|
|
|
## 项目专用验收要求
|
|
|
|
- `<填写>`
|