Skip to content

Fix Youmu directions and clarify asset usage terms - #29

Merged
legeling merged 1 commit into
mainfrom
fix/youmu-directions-and-license-policy
Jul 17, 2026
Merged

Fix Youmu directions and clarify asset usage terms#29
legeling merged 1 commit into
mainfrom
fix/youmu-directions-and-license-policy

Conversation

@legeling

@legeling legeling commented Jul 17, 2026

Copy link
Copy Markdown
Owner

Summary

  • correct Youmu v2 cardinal and intermediate look directions after merging Add Youmu AI-generated pet #28
  • preserve all standard action rows and rebuild only the two look rows from existing cells
  • allow either a formal asset license or an explicit non-commercial-only usage statement
  • make public source URLs optional for original, AI-generated, and privately sourced submissions

Verification

  • three independent blind direction reviews passed the hard 000/090/180/270 gates
  • generated previews for all 108 pets
  • npm run validate
  • npm run validate:pr
  • npm run lint
  • isolated Youmu installation with byte-for-byte file comparison

Summary by CodeRabbit

  • 文档

    • 更新投稿指南、贡献指南及模板,明确要求提供素材使用条件。
    • 正式许可证不再强制;缺少许可证时,需明确仅限非商业使用并确认有权投稿。
    • 补充来源链接可选时的来源说明要求,并同步更新中英文文档。
  • 数据更新

    • 调整相关素材的许可与描述,改为明确的非商业使用声明。
    • 更新中文项目说明中的许可政策表述。

@qodo-code-review

Copy link
Copy Markdown

Qodo reviews are paused for this user.

Troubleshooting steps vary by plan Learn more →

On a Teams plan?
Reviews resume once this user has a paid seat and their Git account is linked in Qodo.
Link Git account →

Using GitHub Enterprise Server, GitLab Self-Managed, or Bitbucket Data Center?
These require an Enterprise plan - Contact us
Contact us →

@coderabbitai

coderabbitai Bot commented Jul 17, 2026

Copy link
Copy Markdown

Review Change Stack

📝 Walkthrough

Walkthrough

本次更新统一投稿流程中的资产使用条款:正式许可证名称可选,但缺少时需明确非商业限制、投稿权和来源说明;相关模板、指南、示例资产及 README 文案均已同步调整。

Changes

资产使用条款规范化

Layer / File(s) Summary
投稿政策与检查项
AGENTS.md, CONTRIBUTING.md, .github/*, docs/*/CONTRIBUTING.md
更新投稿政策、Issue 模板和 PR 检查清单,要求提供正式许可证或明确的非商业使用声明,并补充来源与投稿权说明。
投稿指南与来源说明
docs/en/submission-guide.md, docs/zh-CN/submission-guide.md
将指南中的许可、来源、AI 辅助和分享要求统一改为资产使用条件及来源说明口径。
示例资产与 README 输出
pets.json, pets/youmu--ai-generated/submission.json, scripts/generate-readmes.mjs, docs/zh-CN/README.md
将 Youmu 示例资产从 CC BY 4.0 相关表述改为仅限非商业使用,并同步 README 生成文案。

Estimated code review effort: 2 (Simple) | ~10 minutes

Possibly related PRs

Poem

小兔蹦蹦改条款,
正式许可可选填。
非商声明要写明,
来源权利不隐瞒。
README 也换新颜。

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Docstring Coverage ⚠️ Warning Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%. Write docstrings for the functions missing them to satisfy the coverage threshold.
✅ Passed checks (4 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed 标题准确概括了本次对 Youmu 方向调整和素材使用条款澄清这两类主要变更。
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
📝 Generate docstrings
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch fix/youmu-directions-and-license-policy

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 3

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In @.github/ISSUE_TEMPLATE/pet-submission.yml:
- Around line 126-128: Quote the entire placeholder value in the asset
submission field so the embedded “or:” is treated as literal text rather than
YAML mapping syntax. Update only the placeholder under the “Asset license or
non-commercial use statement” field and preserve its displayed wording.

In `@AGENTS.md`:
- Line 175: 更新 AGENTS.md 中负责校验 submission.json.license
的门禁规则,拒绝空值、“unknown”等无法证明许可或使用范围的内容;接受可识别的正式许可证,或包含明确“仅限非商业使用/禁止商用”含义的自定义说明。确保无法自动验证的许可信息进入强制人工审核,并使校验行为与文档中的许可要求一致。

In `@scripts/generate-readmes.mjs`:
- Line 325: 同步更新 scripts/generate-readmes.mjs 中 englishReadme()
的许可政策文案,使其与中文模板一致,移除 “Open licensing” 和固定的 “CC BY-NC 4.0” 表述,并重新运行 npm run
readmes 生成并提交两个 README。
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: ea614c8c-832d-4edc-b890-723ff31bb481

📥 Commits

Reviewing files that changed from the base of the PR and between f344b10 and 76d2b7d.

📒 Files selected for processing (13)
  • .github/ISSUE_TEMPLATE/pet-submission.yml
  • .github/PULL_REQUEST_TEMPLATE.md
  • AGENTS.md
  • CONTRIBUTING.md
  • docs/en/CONTRIBUTING.md
  • docs/en/submission-guide.md
  • docs/zh-CN/CONTRIBUTING.md
  • docs/zh-CN/README.md
  • docs/zh-CN/submission-guide.md
  • pets.json
  • pets/youmu--ai-generated/spritesheet.webp
  • pets/youmu--ai-generated/submission.json
  • scripts/generate-readmes.mjs
👮 Files not reviewed due to content moderation or server errors (1)
  • pets/youmu--ai-generated/spritesheet.webp

Comment on lines +126 to +128
label: Asset license or non-commercial use statement
description: A formal license is optional. If none applies, state clearly that the asset is for non-commercial use only and that you have the right to submit it.
placeholder: CC BY-NC 4.0, or: Non-commercial use only; I confirm I have the right to submit this asset.

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🎯 Functional Correctness | 🔴 Critical | ⚡ Quick win

为包含冒号的占位符加引号。

placeholder 值中的 or: 未加引号,会被 YAML 解析为映射语法,导致 Issue 表单无法加载。请将整个值包裹在双引号中,或改用块字符串。

建议修复
-      placeholder: CC BY-NC 4.0, or: Non-commercial use only; I confirm I have the right to submit this asset.
+      placeholder: "CC BY-NC 4.0, or: Non-commercial use only; I confirm I have the right to submit this asset."
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
label: Asset license or non-commercial use statement
description: A formal license is optional. If none applies, state clearly that the asset is for non-commercial use only and that you have the right to submit it.
placeholder: CC BY-NC 4.0, or: Non-commercial use only; I confirm I have the right to submit this asset.
label: Asset license or non-commercial use statement
description: A formal license is optional. If none applies, state clearly that the asset is for non-commercial use only and that you have the right to submit it.
placeholder: "CC BY-NC 4.0, or: Non-commercial use only; I confirm I have the right to submit this asset."
🧰 Tools
🪛 YAMLlint (1.37.1)

[error] 128-128: syntax error: mapping values are not allowed here

(syntax)

🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In @.github/ISSUE_TEMPLATE/pet-submission.yml around lines 126 - 128, Quote the
entire placeholder value in the asset submission field so the embedded “or:” is
treated as literal text rather than YAML mapping syntax. Update only the
placeholder under the “Asset license or non-commercial use statement” field and
preserve its displayed wording.

Source: Linters/SAST tools

Comment thread AGENTS.md
- pet 资产和自动生成预览:`CC BY-NC 4.0`

如果某个 pet 使用不同许可证,必须在其 `submission.json` 中明确写出
投稿不强制使用某个正式许可证名称。`submission.json.license` 可以填写 SPDX/Creative Commons 等正式许可证,也可以填写清楚的自定义使用说明;没有正式许可证时,至少必须明确“仅限非商业使用/禁止商用”。提交者仍需确认自己有权投稿并如实说明作者和素材来源;原创、AI 生成或无法公开链接的素材可以不提供公开 `source_url`,但应在来源类型、描述或使用说明中交代情况

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🗄️ Data Integrity & Integration | 🟠 Major | 🏗️ Heavy lift

让校验门禁真正落实新的许可要求。

当前校验器只检查 submission.json.license 是否非空,无法阻止 "unknown" 等不构成正式许可证或非商业声明的内容通过。请补充可验证的格式/关键词规则,或明确将该项交由强制人工审核,避免文档政策与实际门禁脱节。

As per coding guidelines, license 必须是正式许可证或清楚的使用说明,并在无正式许可证时明确仅限非商业使用。

🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@AGENTS.md` at line 175, 更新 AGENTS.md 中负责校验 submission.json.license
的门禁规则,拒绝空值、“unknown”等无法证明许可或使用范围的内容;接受可识别的正式许可证,或包含明确“仅限非商业使用/禁止商用”含义的自定义说明。确保无法自动验证的许可信息进入强制人工审核,并使校验行为与文档中的许可要求一致。

Source: Coding guidelines

- **精品宠物画廊** — [awesome-codex-pet.pages.dev](${websiteUrl}) 提供完整动作预览、合集、作者署名、便捷分享和社区统计
- **GitHub 原生投稿** — 提 issue 或 PR,剩下的全自动
- **明确许可** — 代码 MIT,宠物资源 CC BY-NC 4.0
- **非商用原则** — 正式许可证可选;没有正式许可证时必须明确禁止商用

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🗄️ Data Integrity & Integration | 🟠 Major | ⚡ Quick win

同步更新英文 README 模板。

这里只修改了中文模板;englishReadme() 仍在 Line 171 宣称 “Open licensing” 且在 Line 298 固定写作 CC BY-NC 4.0。运行 npm run readmes 后,英文和中文 README 会再次出现相互矛盾的许可政策。请同步修改英文模板并重新生成两个 README。

As per coding guidelines, README 输出必须同步生成;相关学习也要求完成后运行 npm run readmes

🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@scripts/generate-readmes.mjs` at line 325, 同步更新 scripts/generate-readmes.mjs
中 englishReadme() 的许可政策文案,使其与中文模板一致,移除 “Open licensing” 和固定的 “CC BY-NC 4.0”
表述,并重新运行 npm run readmes 生成并提交两个 README。

Sources: Coding guidelines, Learnings

@legeling
legeling merged commit e939f69 into main Jul 17, 2026
3 checks passed
@legeling
legeling deleted the fix/youmu-directions-and-license-policy branch July 17, 2026 07:18
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.

1 participant