project-knowledge 0.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +34 -0
- package/INDEX.md +53 -0
- package/README.md +79 -0
- package/_site/README.md +63 -0
- package/_site/_test/ai-profile-test.js +199 -0
- package/_site/_test/baseline-schema-test.js +132 -0
- package/_site/_test/commit-analysis-test.js +184 -0
- package/_site/_test/context-pack-test.js +199 -0
- package/_site/_test/draft-apply-test.js +363 -0
- package/_site/_test/git-validation-test.js +171 -0
- package/_site/_test/hook-trigger-test.js +257 -0
- package/_site/_test/initial-analysis-test.js +228 -0
- package/_site/_test/job-orchestrator-test.js +297 -0
- package/_site/_test/kb-v2-templates-test.js +189 -0
- package/_site/_test/pr-consumer-contract-test.js +236 -0
- package/_site/_test/run-all-tests.js +135 -0
- package/_site/_test/scanner-test.js +206 -0
- package/_site/_test/ui-smoke-test.js +237 -0
- package/_site/_test/ui-test.js +237 -0
- package/_site/index.html +1166 -0
- package/_site/lib/ai-adapter.js +287 -0
- package/_site/lib/analysis-orchestrator.js +433 -0
- package/_site/lib/context-pack-builder.js +290 -0
- package/_site/lib/draft-apply.js +219 -0
- package/_site/lib/git-runner.js +26 -0
- package/_site/lib/hook-manager.js +148 -0
- package/_site/lib/job-orchestrator.js +231 -0
- package/_site/lib/kb-validator.js +224 -0
- package/_site/lib/llm-client.js +126 -0
- package/_site/lib/scanner.js +94 -0
- package/_site/scripts/hook-trigger.js +133 -0
- package/_site/scripts/safe-runner.js +151 -0
- package/_site/server.js +1058 -0
- package/_site/start.bat +26 -0
- package/_site/stop.bat +11 -0
- package/ai-profiles.json +18 -0
- package/docs/ai-knowledge-base-system-design.md +395 -0
- package/docs/pr-consumer-contract.md +198 -0
- package/docs/project-goal.md +72 -0
- package/docs/project-registry-schema.md +46 -0
- package/docs/testing-strategy.md +169 -0
- package/iterations.json +23 -0
- package/package.json +47 -0
- package/scripts/gen-commit-doc.ps1 +178 -0
- package/scripts/gen-commit-doc.sh +197 -0
- package/scripts/list-features.ps1 +41 -0
- package/scripts/register-scheduled-task.bat +5 -0
- package/templates/change.md +59 -0
- package/templates/commit-feature.md +56 -0
- package/templates/feature.md +44 -0
- package/templates/framework.md +80 -0
- package/templates/index-header.md +3 -0
- package/templates/kb-manifest.json +38 -0
- package/templates/module.md +58 -0
- package/templates/project-analysis.md +48 -0
- package/templates/project-goal.md +55 -0
- package/templates/project-readme.md +60 -0
- package/templates/quality-review-rules.md +37 -0
- package/templates/update-entry.md +7 -0
|
@@ -0,0 +1,60 @@
|
|
|
1
|
+
---
|
|
2
|
+
slug: <slug>
|
|
3
|
+
displayName: <项目显示名>
|
|
4
|
+
localPath: <项目本地绝对路径>
|
|
5
|
+
gitPath: <项目本地 git 路径>
|
|
6
|
+
primaryLanguage: <主要语言>
|
|
7
|
+
category: <web-fullstack | cli-tool | data-platform | desktop-app | reference>
|
|
8
|
+
tags: [<tag1>, <tag2>, ...]
|
|
9
|
+
status: <active | slow | reference | deprecated>
|
|
10
|
+
lastActive: <YYYY-MM-DD>
|
|
11
|
+
---
|
|
12
|
+
|
|
13
|
+
# <项目显示名>
|
|
14
|
+
|
|
15
|
+
> <一句话描述:这个项目做什么、解决什么问题>
|
|
16
|
+
|
|
17
|
+
## 基本信息
|
|
18
|
+
|
|
19
|
+
| 项 | 值 |
|
|
20
|
+
|----|----|
|
|
21
|
+
| 本地路径 | `<localPath>` |
|
|
22
|
+
| Git 路径 | `<gitPath>` |
|
|
23
|
+
| 主要语言 | `<primaryLanguage>` |
|
|
24
|
+
| 分类 | `<category>` |
|
|
25
|
+
| 状态 | `<status>` |
|
|
26
|
+
| 最近活跃 | `<lastActive>` |
|
|
27
|
+
|
|
28
|
+
## 技术栈
|
|
29
|
+
|
|
30
|
+
- **语言**:<...>
|
|
31
|
+
- **框架**:<...>
|
|
32
|
+
- **存储**:<...>
|
|
33
|
+
- **构建**:<...>
|
|
34
|
+
- **测试**:<...>
|
|
35
|
+
|
|
36
|
+
## 知识库目录
|
|
37
|
+
|
|
38
|
+
```
|
|
39
|
+
projects/<slug>/
|
|
40
|
+
├── README.md # 本文件
|
|
41
|
+
├── framework.md # 框架说明(技术栈细节、启动方式、架构图)
|
|
42
|
+
├── architecture/ # 架构图
|
|
43
|
+
├── modules/ # 功能模块(00-index.md 是入口)
|
|
44
|
+
├── commits/ # git 提交的功能变更
|
|
45
|
+
├── operations/ # 部署/运维
|
|
46
|
+
└── references/ # 与项目源码的对应关系
|
|
47
|
+
```
|
|
48
|
+
|
|
49
|
+
## 阅读建议
|
|
50
|
+
|
|
51
|
+
1. 第一次看 → [framework.md](./framework.md)
|
|
52
|
+
2. 找某个模块 → [modules/00-index.md](./modules/00-index.md)
|
|
53
|
+
3. 找某次提交的功能变更 → [commits/00-index.md](./commits/00-index.md)
|
|
54
|
+
4. 源码与文档对应 → [references/source-map.md](./references/source-map.md)
|
|
55
|
+
|
|
56
|
+
## 关联资源
|
|
57
|
+
|
|
58
|
+
- 仓库地址:<git remote URL>
|
|
59
|
+
- 部署文档:[operations/](./operations/)(如有)
|
|
60
|
+
- 上游链接:<上游仓库(参考项目用)>
|
|
@@ -0,0 +1,37 @@
|
|
|
1
|
+
---
|
|
2
|
+
schema: quality-review-rules/v1
|
|
3
|
+
project: __PROJECT__
|
|
4
|
+
updatedAt: __DATE__
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
# Quality Review Rules — __PROJECT__
|
|
8
|
+
|
|
9
|
+
Rules the future PR-review project should enforce before accepting a change.
|
|
10
|
+
|
|
11
|
+
## Goal Alignment
|
|
12
|
+
|
|
13
|
+
- [ ] Change is justified by a project-goal scenario in `project-goal.md`.
|
|
14
|
+
- [ ] Change does not contradict any non-goal.
|
|
15
|
+
|
|
16
|
+
## Architecture
|
|
17
|
+
|
|
18
|
+
- [ ] Does not introduce a cyclic dependency.
|
|
19
|
+
- [ ] Respects existing layering.
|
|
20
|
+
- [ ] Touches the smallest set of modules possible.
|
|
21
|
+
|
|
22
|
+
## Testing
|
|
23
|
+
|
|
24
|
+
- [ ] New behavior has at least one test.
|
|
25
|
+
- [ ] Bug fix includes a regression test.
|
|
26
|
+
- [ ] No test was deleted without explanation.
|
|
27
|
+
|
|
28
|
+
## Documentation
|
|
29
|
+
|
|
30
|
+
- [ ] Feature docs updated if user-visible behavior changed.
|
|
31
|
+
- [ ] `project-analysis.md` evidence list cites the new commit when the change is large.
|
|
32
|
+
|
|
33
|
+
## Safety
|
|
34
|
+
|
|
35
|
+
- [ ] No secrets, tokens, or local paths in committed files.
|
|
36
|
+
- [ ] No destructive operations on shared resources.
|
|
37
|
+
- [ ] `project-goal.md` is never edited by an AI apply step.
|