Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 25 additions & 0 deletions .github/ISSUE_TEMPLATE/atlas_feedback.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
---
name: 图谱反馈 / Atlas feedback
about: 提建议、纠错、补充资源、讨论图谱扩建方向
title: "[feedback] <node or topic>: <一句话>"
labels: ["feedback", "triage"]
---

**相关节点 / Node**
例如 `course:zhao_rl`、`paper:2212.10156`、`concept:bellman_eq`,若是全局建议可留空。

**建议类型 / Type**
内容补充 / 纠错 / 新资源 / 图谱关系 / 页面交互 / lab / 其他:

**建议内容 / Suggestion**
请尽量说明“为什么这能帮助同行读者更快理解这张图”。

**证据或参考 / Evidence**
论文链接、视频时间戳、代码位置、截图、复现步骤等:

**贡献标注 / Attribution**
若建议被采纳并进入卡片、graph、playbook 或 lab,你希望如何被标注?

- GitHub: `@username`
- 名字 / 机构:
- 不需要标注:
1 change: 1 addition & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@
- [ ] 所有改动到的 lab 在本地用 `LLM_BACKEND=mock` 跑过 `nbconvert --execute`
- [ ] 卡片新增 / 修改时同步更新了 `concepts.md` / playbook(如相关)
- [ ] 对外链接尽量是**深度锚**(PDF `#page=N`、YouTube `&t=Xs` 等)
- [ ] 采纳外部建议时已在相关卡片加入 `contributors: [...]`,或说明不需要标注

## 备注 / Notes
(截图、性能数字、与 [`AGENTS.md`](../AGENTS.md) 的对照说明等)
1 change: 1 addition & 0 deletions AGENTS.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@ This repo is a public, opinionated, bilingual learning atlas. Anyone (human or a
3. Add the node + at least one edge to docs/data/graph.json.
4. Run python tools/validate_graph.py and python tools/check_links.py.
5. If the card has a matching lab, add labs/labXX_*.ipynb and ensure it passes nbconvert --execute with the Mock LLM backend.
6. If an accepted issue or outside review materially shaped the change, add contributors: ["@github-handle"] to the card front matter unless the contributor declined attribution.

## Lab conventions

Expand Down
25 changes: 25 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
# Contributing

This atlas grows best when feedback stays reviewable, discussable, and traceable.

## Feedback flow

1. Open an issue with the `Atlas feedback` template for ideas, corrections, missing resources, graph-edge suggestions, or UX problems.
2. The maintainer triages the issue: accept, ask for evidence, merge into an existing thread, or close as out of scope.
3. Accepted ideas become a short-lived branch and pull request.
4. The PR updates the relevant card, `docs/data/graph.json`, playbook, lab, or site code.
5. If the contributor wants attribution, add them to the card front matter with `contributors: [@github-handle]`.

## Contributor attribution

Use `contributors` for people whose suggestion or review materially shaped a card or expansion:

```yaml
contributors: ["@alice", "@bob"]
```

The live site renders this field on the card. GitHub PR authorship remains the source of truth for code changes.

## Why issues, not a raw suggestions folder?

Issues are better for intake because visitors do not need write access, discussion is threaded, labels make triage visible, and accepted work can close the issue from a PR. The repo still keeps the durable result: updated cards, graph edges, playbooks, labs, and contributor metadata.
4 changes: 3 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -109,8 +109,10 @@ Autonomous-Driving-Learning-Atlas/

## 贡献 / Contributing

- 有想法、纠错、资源推荐或页面体验问题,优先开 [Atlas feedback issue](https://github.com/ChatGPU/Autonomous-Driving-Learning-Atlas/issues/new/choose);这样讨论、证据、状态和后续 PR 都能追踪。
- 修补深度链接、补充新概念、加 lab 都欢迎,请走 PR;CI 会校验图谱完整性 & lab 可跑性。
- 在 [Discussions](https://github.com/ChatGPU/Autonomous-Driving-Learning-Atlas/discussions) 里提议要新增的论文或 playbook。
- 采纳后的实质贡献可在对应卡片 front matter 里加入 `contributors: ["@github-handle"]`,页面会自动显示贡献标注。
- 更完整的流程见 [`CONTRIBUTING.md`](CONTRIBUTING.md)。

## 引用 / Citation

Expand Down
Loading
Loading