Doc: Keep git to long-term records and ignore local scratch
Ignore /local for short-term benchmark evidence, one-off A/B raw logs, and ad-hoc probes, and record the repository hygiene rule in AGENTS.md.
This commit is contained in:
1 parent
3cbf5ba386
commit
a510fec23e
2 files changed
+9
No files matched your search
@@ -1,5 +1,6 @@
|
||||
/build
|
||||
/output
|
||||
/local
|
||||
/scripts/__pycache__
|
||||
assets/2mass/processed/all_sky/*.csv
|
||||
assets/2mass/processed/all_sky/.done/
|
||||
@@ -76,6 +76,14 @@ catalog 内部数据保留 `(direction, temperature, amplitude)`,而非 RGB。
|
||||
|
||||
性能 benchmark 记录必须保留完整、可复制的命令及原始终端输出,不能只记录汇总耗时或吞吐量;输出中的 build/cache、输入加载、工作线程、处理数量与 fallback 等统计是后续正确归因性能变化的证据。
|
||||
|
||||
## 仓库卫生与短期产物
|
||||
|
||||
只有对本项目有长期记录价值、且值得进入 public repo 的测试与 benchmark 才纳入 git。
|
||||
|
||||
- 短期性能对照、一次性 A/B 原始日志、临时测量脚本、ad-hoc probe 与中间数据放到仓库根目录的 `local/`;该目录已被 `.gitignore` 排除,不进入版本库。
|
||||
- 追踪文件必须可复现:命令把输出、原始日志写到 `/tmp` 或 `local/` 是正常的,这些仓库外/被忽略的数据无需跟踪;但复现所需的输入、脚本、fixture 必须一并纳入 git(放在 `scripts/` 或 `benchmarks/<name>/`),不得依赖未跟踪的脚本或数据。
|
||||
- `benchmarks/` 只保留自包含、可复现的长期记录;`tests/` 只保留针对生产代码的回归测试,不保留为单次实验服务的一次性探针。
|
||||
|
||||
## 修改原则
|
||||
|
||||
- 改动应保持 backend、observer、geodesic、movie mesh 与 optics 的职责分离。
|
||||
|
||||
Reference in new issue
Block a user