Skip to content

docs(contest): update AI Coding log guide for workspace-gated auto-export#602

Merged
tanghao-xiaomi merged 1 commit into
open-vela:dev-ai-contest-2026from
yanxingyu17:docs-update-log-guide-for-auto-export
Jun 18, 2026
Merged

docs(contest): update AI Coding log guide for workspace-gated auto-export#602
tanghao-xiaomi merged 1 commit into
open-vela:dev-ai-contest-2026from
yanxingyu17:docs-update-log-guide-for-auto-export

Conversation

@yanxingyu17

Copy link
Copy Markdown
Collaborator

What this PR does

Updates the contestant-facing "AI Coding 日志归集与提交手册" to match
the new collector behavior shipped in open-vela/.claude PR #27:

  • Workspace gate replaces manual confirm as the privacy boundary.
    The collector now only activates inside an openvela workspace
    (detected by .repo/ directory). Sessions outside the workspace
    (personal projects, random dirs) are not collected at all.
  • Auto-export on session end. Sessions inside the workspace are
    automatically written into logs/<github_login>/ when they end; no
    contest-snapshot --confirm needed for the normal path.
  • git push still required. The tool only writes local files; the
    contestant decides when to push.

Sections changed

  • Opening paragraph + flow overview → new model
  • Key terms → add "workspace gate", reframe staging/export
  • §II (AI tools) → sessions auto-write to repo logs/, not just staging
  • §III (submit) → auto-export is primary; manual tool is optional
  • §IV (privacy) → workspace gate is the boundary, not manual confirm
  • FAQ Q1-Q4, Q7 → answers aligned with workspace-gated model
  • Appendix → logs/ appears automatically, not only after --confirm

Verification

  • 0 internal-only references
  • "openvela" all-lowercase throughout
  • No remaining contradictions from old "must manually confirm" model
  • commit -s applied

…port

The collector behavior has changed (see open-vela/.claude PR open-vela#27):

* Privacy gate is now workspace-based: the collector only activates
  inside an openvela workspace (detected by .repo/ directory), and
  does not collect anything outside it (not even to staging).
* Sessions inside the workspace auto-export into the contest repo's
  logs/ at session end; the manual contest-snapshot --confirm is no
  longer required for the normal path.
* The tool only writes files; it never git commits or pushes.

This commit updates the contestant-facing guide to match:

* Opening paragraph and flow overview: describe the new model.
* Key terms: add "workspace gate" concept; reframe staging/export.
* Section II: sessions now auto-write to repo logs/ (not just staging).
* Section III: auto-export is the primary path; manual tool is optional.
* Section IV (privacy): the boundary is the workspace gate, not manual
  confirm. Personal projects outside the workspace are never collected.
* FAQ Q1-Q4, Q7: answers updated to reflect workspace-gated model.
* Appendix: logs/ directory now appears automatically after first
  in-workspace AI session, not only after manual --confirm.

Signed-off-by: v-yanxingyu <v-yanxingyu@xiaomi.com>
@yanxingyu17 yanxingyu17 requested review from a team as code owners June 17, 2026 08:49
@tanghao-xiaomi tanghao-xiaomi merged commit 0739e4a into open-vela:dev-ai-contest-2026 Jun 18, 2026
4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants